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 Logging documentation following Markdownlint #219

Merged
merged 3 commits into from
Aug 25, 2023

Conversation

normal-coder
Copy link
Contributor

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

Summary

Resolves #225

improve Logging documentation. The main changes are as follows:

  • locale for supplementary code blocks
  • Fixed part of the content interrupted by line breaks
  • remove the $ symbol from the header of the code block of the pure command
  • Replace unreasonable tab placeholders with spaces

Reference from specification:

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 30094d0
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/64e845d86608d4000823d22a
😎 Deploy Preview https://deploy-preview-219--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.

Specification reference: https://github.com/DavidAnson/markdownlint/

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>
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)
…onsole` with `bash`

Resolves sigstore#225

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>
@ltagliaferri ltagliaferri merged commit 9396c99 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.

Use MarkdownLint to correct irregular Markdown writing in documents
2 participants