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

Docs updates to install inspec 6 #6574

Merged
merged 12 commits into from
Oct 18, 2023
Merged

Docs updates to install inspec 6 #6574

merged 12 commits into from
Oct 18, 2023

Conversation

IanMadd
Copy link
Contributor

@IanMadd IanMadd commented Jul 21, 2023

Add and update docs to install and license InSpec 6.

Description

Adds/updates the following pages:

  • install instructions at docs.chef.io/inspec/install/
  • license content at docs.chef.io/inspec/license/, which includes:
    • accept license
    • set license key
    • use local license service
  • supported platforms content at docs.chef.io/inspec/platforms
  • uninstall instructions at docs.chef.io/inspec/uninstall

Adds a new Install menu section that includes the above ☝️ pages.
Note since the menu config was just added to this repo this menu config will be overridden by the InSpec menu config in chef-web-docs until it's removed there.

The existing Cloud Platforms page is moved to docs.chef.io/inspec/cloud_platforms.

Related PRs

chef/chef-web-docs#4140
chef/license-service#346

Related Issue

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.

@github-actions github-actions bot added the Documentation ZH multi-repo label for the docs-team label Jul 21, 2023
@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!

@netlify
Copy link

netlify bot commented Aug 8, 2023

Deploy Preview for chef-inspec ready!

Name Link
🔨 Latest commit d31a8e3
🔍 Latest deploy log https://app.netlify.com/sites/chef-inspec/deploys/65206df6a361a600082e033e
😎 Deploy Preview https://deploy-preview-6574--chef-inspec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sudo zypper install /path-to/inspec.rpm
```

## Providing or Generating a License Key On First Run of Chef InSpec 6
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@IanMadd This section is new. Missing links. If you think it need restructuring I'm open to that.

@IanMadd
Copy link
Contributor Author

IanMadd commented Aug 17, 2023

@clintoncwolfe What is the text of error code 173 when you don't enter a license key? We should add that to the troubleshooting page. See #6609.

@IanMadd IanMadd changed the base branch from inspec-6 to main August 18, 2023 18:01

```bash
Please choose one of the options below I already have a license ID
Please enter your license ID: tmns-34514522-bfe3-4fe7-850c-3fea317c810b-8089
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a public-safe dummy value. I wanted to use realistic values. If you feel it is better, documentation-wise, to use a placeholder, I'm amenable.

@IanMadd IanMadd changed the title Docs updates to install inspec 5 & 6 Docs updates to install inspec 6 Aug 24, 2023
@IanMadd IanMadd marked this pull request as ready for review August 25, 2023 13:26
@IanMadd IanMadd requested review from a team as code owners August 25, 2023 13:26
IanMadd and others added 9 commits October 5, 2023 10:18
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
…nse page

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@clintoncwolfe clintoncwolfe merged commit 921ce66 into main Oct 18, 2023
5 of 7 checks passed
@clintoncwolfe clintoncwolfe deleted the im/install_inspec_6 branch October 18, 2023 20:35
chef-expeditor bot pushed a commit that referenced this pull request Oct 18, 2023
Obvious fix; these changes are the result of automation not creative thinking.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants