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 license key error to troubleshooting page #6609

Merged
merged 3 commits into from
Sep 8, 2023
Merged

Conversation

IanMadd
Copy link
Contributor

@IanMadd IanMadd commented Aug 17, 2023

Description

InSpec 6 requires a license key and if it's not provided it will give an error.

Add text in the troubleshooting page that describes the error and links to docs for correcting the error.

Related Issue

#6574

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.

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@netlify
Copy link

netlify bot commented Aug 17, 2023

Deploy Preview for chef-inspec ready!

Name Link
🔨 Latest commit d0bb353
🔍 Latest deploy log https://app.netlify.com/sites/chef-inspec/deploys/64ee4b876225a40007e54b64
😎 Deploy Preview https://deploy-preview-6609--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.

@github-actions github-actions bot added the Documentation ZH multi-repo label for the docs-team label Aug 17, 2023
@IanMadd IanMadd mentioned this pull request Aug 17, 2023
4 tasks
@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!

@@ -22,3 +22,9 @@ See the relevant resource pack readme for instructions:
- [inspec-aws README](https://github.com/inspec/inspec-aws#use-the-resources)
- [inspec-azure README](https://github.com/inspec/inspec-azure#use-the-resources)
- [inspec-gcp README](https://github.com/inspec/inspec-gcp#use-the-resources)

## Error 173
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be clearer to say "Exit Code 173" - we don't have numbered error messages, and this somewhat implies that we do.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is exit code 174 when license is not set for inspec
Exit code 173 is when license is not entitled to inspec software

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@IanMadd IanMadd marked this pull request as ready for review August 18, 2023 18:02
@IanMadd IanMadd requested review from a team as code owners August 18, 2023 18:02
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@clintoncwolfe clintoncwolfe merged commit 99b520c into main Sep 8, 2023
5 of 6 checks passed
@clintoncwolfe clintoncwolfe deleted the im/troubleshooting branch September 8, 2023 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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