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.

Sign up for GitHub

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

Jump to bottom

docs: document formatting quirks of MkDocs and markdownlint #3034

Merged
merged 30 commits into from
Mar 7, 2024
Merged

docs: document formatting quirks of MkDocs and markdownlint #3034

merged 30 commits into from
Mar 7, 2024

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Feb 13, 2024 •
edited
Loading

Summary

This PR documents some quirks for coding the docs to work with our tools. See the related issue for details.

Fixes #2822

Checks

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • [n/a] I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Feb 13, 2024
@StackScribe StackScribe added this to the 0.11 milestone Feb 13, 2024
@StackScribe StackScribe self-assigned this Feb 13, 2024
@StackScribe StackScribe requested review from a team as code owners February 13, 2024 03:31
@StackScribe StackScribe marked this pull request as draft February 13, 2024 03:31
@StackScribe
verbage
b404722 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
mkdocs.yml
1f2397e 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
docs: document doc coding practices for our tools
5a364c2 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
docmentation
4e1d5e6 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
code block indentation
39331a1 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe StackScribe requested a review from geoffrey1330 March 5, 2024 07:00
@mowies mowies removed this from the 2.0.0-rc.1 milestone Mar 5, 2024
@odubajDT odubajDT marked this pull request as ready for review March 5, 2024 07:19
@StackScribe
yaml code
09a8221 
Signed-off-by: Meg McRoberts <[email protected]>
odubajDT
odubajDT reviewed Mar 5, 2024
View reviewed changes
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
mowies
mowies reviewed Mar 5, 2024
View reviewed changes
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Show resolved Hide resolved
docs/docs/contribute/docs/code-docs.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/source-file-structure.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/source-file-structure.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/source-file-structure.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/source-file-structure.md Outdated Show resolved Hide resolved
docs/docs/contribute/docs/source-file-structure.md Show resolved Hide resolved
StackScribe and others added 8 commits March 5, 2024 03:33
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
57d4b4c 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
8141489 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
50440ad 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
290a8f5 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
25373a0 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
ca45a1b 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
1667c32 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
af96787 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe and others added 14 commits March 5, 2024 03:37
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
0d62866 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
4330e1c 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
cf287c6 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
8a12a34 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
e551a46 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
11ee58d 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
51827fd 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @odubajDT
Update docs/docs/contribute/docs/code-docs.md
0562655 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/source-file-structure.md
073e5b2 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/source-file-structure.md
b4ea0f8 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/source-file-structure.md
527212b 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/source-file-structure.md
37bed43 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs/docs/contribute/docs/code-docs.md
f7cbe78 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
spelling
f673359 
Signed-off-by: Meg McRoberts <[email protected]>
@github-actions github-actions bot added the ops label Mar 5, 2024
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Mar 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

mowies
mowies approved these changes Mar 6, 2024
View reviewed changes
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM!

@odubajDT odubajDT merged commit fb882b0 into main Mar 7, 2024
11 checks passed
@odubajDT odubajDT deleted the 0212-quirks branch March 7, 2024 08:38
@keptn-bot keptn-bot mentioned this pull request Mar 6, 2024
Merged
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
@StackScribe @odubajDT
@mowies @Vickysomtee
docs: document formatting quirks of MkDocs and markdownlint (keptn#3034)
3d459f5 
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Co-authored-by: odubajDT <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: vickysomtee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@odubajDT odubajDT odubajDT approved these changes

@mowies mowies mowies approved these changes

@geoffrey1330 geoffrey1330 Awaiting requested review from geoffrey1330

Assignees

@StackScribe StackScribe

Labels
documentation Improvements or additions to documentation ops
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document xref and markdown quirks with new tools
4 participants
@StackScribe @mowies @geoffrey1330 @odubajDT