chef / chef/chef-web-docs

InSpec Platform Resource Docs

Open
#2,815 1 comment 0 reactions 1 assignee View on GitHub

@IanMadd is already working on this.

Since Dec 29, 2020.

Component: Chef Infra Client Component: Chef InSpec Topic: Resources
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

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:

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.