Remove no-longer-working documentation-generation gem and associated tasks
Clarify usage of port 9292
Minor linting
Note for future software archiologists:
The Raml gem (v0.1.1) was previously used to generate the nice-looking API docs from a .raml API definition file. Unfortunately, this functionality was removed in this commit and is no-longer part of the package - with no direct replacement. Worse still, due to Rails upgrades, the original version (v0.1.1) is no longer compatible with the Print My Barcode application. As such, I have removed the package and associated documentation generation task docs:api and moved future documentation to the Readme (single quick-start example) and Confluence page (full details).
Instructions for Reviewers
[All PRs] - Confirm PR template filled [Feature Branches] - Review code [Production Merges to main]
- Check story numbers included
- Check for debug code
- Check version
Changes proposed in this pull request
Note for future software archiologists:
The Raml gem (
v0.1.1) was previously used to generate the nice-looking API docs from a.ramlAPI definition file. Unfortunately, this functionality was removed in this commit and is no-longer part of the package - with no direct replacement. Worse still, due to Rails upgrades, the original version (v0.1.1) is no longer compatible with the Print My Barcode application. As such, I have removed the package and associated documentation generation taskdocs:apiand moved future documentation to the Readme (single quick-start example) and Confluence page (full details).Instructions for Reviewers
[All PRs] - Confirm PR template filled
[Feature Branches] - Review code
[Production Merges to
main]- Check story numbers included
- Check for debug code
- Check version