Open
Description
User Story
The InSpec Platform Resource docs are not up to date and there's no easy way to get them there.
Description
The Inspec resource pack docs don't match their current state in the resource pack repos.
The current InSpec resources docs are here
The current state of the resource pack docs are here:
- https://github.com/inspec/inspec-gcp/tree/master/docs
- https://github.com/inspec/inspec-aws/tree/master/docs/resources
- https://github.com/inspec/inspec-azure/tree/master/docs
- https://github.com/inspec/inspec-habitat/tree/master/docs/resources
The GCP resource docs are maintained by Modular Magician, so we can't really change those. But we can change the others.
Steps:
- Munge the non-GCP resource docs into a format that works for us.
- Create a ruby script that will copy GCP resource docs into inspec/inspec and modify the page frontmatter to work with Hugo
- Add Expeditor config to watch for changes or expeditor workload in those resource packs, and then:
- update the Hugo modules in the non-GCP resource packs
- copy and munge the GCP resource docs
Issues:
Is there a way to maintain links so they work in GitHub and also work on docs.chef.io