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

improve Key Management documentation following MarkdownLint - MD014 #218

Merged

Conversation

normal-coder
Copy link
Contributor

@normal-coder normal-coder commented Aug 20, 2023

Summary

Resolves #221, #225

improve Key Management documentation.

When there are only commands in the code block, the $ sign is not needed

Reference from specification: https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md014.md

Release Note

None.

Documentation

This PR implements the doc change.

@netlify
Copy link

netlify bot commented Aug 20, 2023

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit 59e142b
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/64e846986a27c500083663e5
😎 Deploy Preview https://deploy-preview-218--docssigstore.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.

@ltagliaferri
Copy link
Collaborator

ltagliaferri commented Aug 21, 2023

Hi @normal-coder — we are doing a code freeze of the docs site which we announced in the #general channel of our community's Slack as we are migrating to Hugo. These PRs will likely need to be rebased.

In any case, our Contributing guidelines note that an issue should be created prior to a PR. I happen to agree about the $ piece in commands as it makes copying and pasting more arduous, but it should be discussed with the community.

…D014

When there are only commands in the code block, the `$` sign is not needed

Specification reference: https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md014.md

Resolves: sigstore#217

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>
@normal-coder normal-coder force-pushed the specification/code-blocks-follow-MD014 branch from 0123f10 to 4968963 Compare August 21, 2023 19:56
@normal-coder
Copy link
Contributor Author

Hi @normal-coder — we are doing a code freeze of the docs site which we announced in the #general channel of our community's Slack as we are migrating to Hugo. These PRs will likely need to be rebased.

In any case, our Contributing guidelines note that an issue should be created prior to a PR. I happen to agree about the $ piece in commands as it makes copying and pasting more arduous, but it should be discussed with the community.

@ltagliaferri No problem, I re-checkout the branch locally and cherry-pick the changes to the latest code.

ltagliaferri
ltagliaferri previously approved these changes Aug 24, 2023
* main:
  ci(github action): add Markdown linter check support for main branch (sigstore#227)
  Redirects now appears in public (sigstore#234)
  add 'cosign sign-blob'in the mTLS TSA section (sigstore#239)
  Changed 404 text, restored i18n (sigstore#238)
  Restored Netlify redirects file (sigstore#233)
  Removed docs from URL path (sigstore#232)
  Corrected the confusion of steps in the document due to formatting (sigstore#220)
  Added anchor text to link to releases page (sigstore#223)
@ltagliaferri ltagliaferri merged commit 0a6e574 into sigstore:main Aug 25, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create shortcode for bash commands
2 participants