Here are the DINA-Web collaboration guidelines:
- Functionality/API guidelines
- Style guidelines
- Licensing guidelines
- Release guidelines
- Quality Assurance guidelines
Discussion topics
Suggested areas to improve across the guidelines:
API guidelines
Suggest change format to use API Blueprint format? This is also markdown but what we suggest for API docs.
- https://github.com/apiaryio/api-blueprint/tree/master/examples
- use and suggest using aglio or equiv to render to .html
-
see renderers here for tools (md -> html): https://apiblueprint.org/tools.html
- Paging support
- Authentication flow
- Batch requests
- JSONAPI format
Style guidelines
- Provide repo w graphical assets with DINA-Web Collections Manager stylesheets etc
- More ideas?
Licensing guidelines
- Any issues? Or do you comply :)
Release and QA guidelines
- Need updated tool recommendations
- Does these guidelines lack anything?
- Do you use them?