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

Fix TOC for chef-vault #3176

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Fix TOC for chef-vault #3176

merged 2 commits into from
Nov 29, 2023

Conversation

chuhn
Copy link
Contributor

@chuhn chuhn commented Nov 9, 2023

The levels of the headings in this document are pretty messed up. It has 3 major sections:

  1. knive vault
  2. Using chef-vault in cookbooks
  3. Using chef-vault standalone

Also "Example Commands" should be one level above the specific commands, not in the same level.

Related Issue

I think the documentation of knife vault should be split out into a separate document and references from here.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

  • I have read the CONTRIBUTING document.
  • I have run the pre-merge tests locally and they pass.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • If Gemfile.lock has changed, I have used --conservative to do it and included the full output in the Description above.
  • All new and existing tests passed.
  • All commits have been signed-off for the Developer Certificate of Origin.

@chuhn chuhn requested a review from a team as a code owner November 9, 2023 13:01
Copy link

netlify bot commented Nov 9, 2023

👷 Deploy Preview for chef-workstation processing.

Name Link
🔨 Latest commit ff54364
🔍 Latest deploy log https://app.netlify.com/sites/chef-workstation/deploys/6566d6b41b6394000859cee2

@IanMadd
Copy link
Contributor

IanMadd commented Nov 21, 2023

@chuhn
Copy link
Contributor Author

chuhn commented Nov 22, 2023

@chuhn can you add your DCO signoff to your commit. https://github.com/chef/chef/blob/main/CONTRIBUTING.md#developer-certification-of-origin-dco

OK, how do I do that technically? Edit the commit and force-push the MR branch?

@IanMadd
Copy link
Contributor

IanMadd commented Nov 22, 2023

@chuhn can you add your DCO signoff to your commit. https://github.com/chef/chef/blob/main/CONTRIBUTING.md#developer-certification-of-origin-dco

OK, how do I do that technically? Edit the commit and force-push the MR branch?

Yeah git commit --amend -s and force push should fix it.

The levels of the headings in this document are pretty messed up. It has 3 major sections:
1. knive vault
2. Using chef-vault in cookbooks
3. Using chef-vault standalone

Also "Example Commands" should be one level above the specific commands, not in the same level.

Signed-off-by: Christopher Huhn <C.Huhn@gsi.de>
@chuhn
Copy link
Contributor Author

chuhn commented Nov 23, 2023

OK, DCO done.

Copy link

sonarcloud bot commented Nov 29, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@ashiqueps ashiqueps merged commit 55ab9bf into chef:main Nov 29, 2023
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants