Reference samples
Reference overview
- GitLab: Reference
- Diátaxis : Reference
CLI
These samples are from Armory’s Continuous Deployment-as-a-Service product. Harness acquired Armory on 22 December 2023.
Original public repo: https://www.github.com/armory/docs-cdaas/
Original public site: developer.armory.io/docs/ Harness took down this site in March, 2024.
I used Snagit’s scrolling feature to capture the screenshots. The main body content is correct, but you do see duplicate left and right menus due to the scrolling capture.
To see image content better, right-click the image and open it in a new browser tab or window.
Product: Armory Continuous Deployment-as-a-Service
Armory Continuous Deployment-as-a-Service didn’t have an exposed REST API, but it did have two CLIs. I originally created CLI cheat sheets with the aim of moving to CLI docs generated when the CLI projects released a version. Instead, the PM, engineering team, and I decided to enhance the documentation in each CLI’s help. I worked with the engineers on language and reviewed all pull requests that contained user-facing output.
Deployment config file
Product: Armory Continuous Deployment-as-a-Service
The Armory Continuous Deployment-as-a-Service reference material detailed the sections of the deployment config file.
REST API
Product: Armory Scale Agent
The docs team worked with the engineers to add comments to the REST API code and then generate a Swagger JSON file upon product release. The docs then displayed the content using the Docsy theme’s swaggerui tag. We ultimately decided not to include the REST API reference content in that format. Instead, I manually created the REST API reference with help from the engineers.
Had Armory not been acquired, I would have investigated using a tools like Stoplight or Redocly for API docs.
Original public repo: https://github.com/armory/docs/tree/master/content/en/plugins
Original public site: https://docs.armory.io/plugins/scale-agent/tasks/dynamic-accounts/manage-accounts/
