Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata to each page in docs.chef.io/inspec, update Edit on GitHub links #5406

Merged
merged 2 commits into from Feb 12, 2021

Conversation

IanMadd
Copy link
Contributor

@IanMadd IanMadd commented Feb 10, 2021

Description

This does two things:

  • update how Edit on GitHub links are generated
  • add product metadata to each page in docs.chef.io/inspec/

We've got a partial in chef-web-docs that handles Edit on GitHub links now, we just need specify which repo each page comes from.

We can use the cascade parameter key in content/inspec/_index.md to add a product value to every page docs.chef.io/habitat/ so we can facet search results by that product

Issues

chef/chef-web-docs#2878
chef/chef-web-docs#2775

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change)
  • Breaking change (a content change which would break existing functionality or processes)

Checklist:

  • I have read the CONTRIBUTING document.

IanMadd added 2 commits February 10, 2021 12:23
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
@IanMadd IanMadd added Aspect: Docs Write the Fine Manual Documentation ZH multi-repo label for the docs-team labels Feb 10, 2021
@IanMadd IanMadd requested a review from a team as a code owner February 10, 2021 23:06
@netlify
Copy link

netlify bot commented Feb 10, 2021

Deploy preview for chef-inspec ready!

Built with commit fbd6c8d

https://deploy-preview-5406--chef-inspec.netlify.app

@chef-expeditor
Copy link
Contributor

Hello IanMadd! Thanks for the pull request!

Here is what will happen next:

  1. Your PR will be reviewed by the maintainers.
  2. Possible Outcomes
    a. If everything looks good, one of them will approve it, and your PR will be merged.
    b. The maintainer may request follow-on work (e.g. code fix, linting, etc). We would encourage you to address this work in 2-3 business days to keep the conversation going and to get your contribution in sooner.
    c. Cases exist where a PR is neither aligned to Chef InSpec's product roadmap, or something the team can own or maintain long-term. In these cases, the maintainer will provide justification and close out the PR.

Thank you for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Aspect: Docs Write the Fine Manual Documentation ZH multi-repo label for the docs-team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants