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: protect nested lists from markdownlint in technologies.md #3020

Merged
merged 1 commit into from
Feb 12, 2024
Merged

docs: protect nested lists from markdownlint in technologies.md #3020

merged 1 commit into from
Feb 12, 2024

Conversation

StackScribe
Copy link
Contributor

This PR corrects the formatting of the "Technologies you should know" page in the "Contributing Guide" and protects them from makemarkdownlint-fix.

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Feb 12, 2024
@StackScribe StackScribe added this to the 0.11 milestone Feb 12, 2024
@StackScribe StackScribe self-assigned this Feb 12, 2024
@StackScribe StackScribe requested review from a team as code owners February 12, 2024 10:24
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@StackScribe StackScribe changed the title docs: protect nested lists from markdownling in technologies.md docs: protect nested lists from markdownlint in technologies.md Feb 12, 2024
@odubajDT
Copy link
Contributor

@StackScribe looks good, but what is the motivation behind this change? do we really want to have the indentation exactly like this with the cost of introducing the markdown-linter ignorers? What advantage do we get from this change ?

@StackScribe
Copy link
Contributor Author

@StackScribe looks good, but what is the motivation behind this change? do we really want to have the indentation exactly like this with the cost of introducing the markdown-linter ignorers? What advantage do we get from this change ?

Without this, we do not have nested lists or code blocks that are within the newsted list item

@odubajDT
Copy link
Contributor

@StackScribe looks good, but what is the motivation behind this change? do we really want to have the indentation exactly like this with the cost of introducing the markdown-linter ignorers? What advantage do we get from this change ?

Without this, we do not have nested lists or code blocks that are within the newsted list item

Thanks for explaining, didn't have the context previously :)

@odubajDT odubajDT merged commit 0574e97 into main Feb 12, 2024
12 checks passed
@odubajDT odubajDT deleted the 0212-format-technologies branch February 12, 2024 15:27
@keptn-bot keptn-bot mentioned this pull request Feb 12, 2024
Merged
Bharadwajshivam28 pushed a commit to Bharadwajshivam28/lifecycle-toolkit that referenced this pull request Feb 20, 2024
@StackScribe @Bharadwajshivam28
docs: protect nested lists from markdownlint in technologies.md (kept…
e5dd5cc 
…n#3020)

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: shivam <[email protected]>
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
@StackScribe @Vickysomtee
docs: protect nested lists from markdownlint in technologies.md (kept…
4be1899 
…n#3020)

Signed-off-by: Meg McRoberts <[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

@RealAnna RealAnna RealAnna approved these changes

Assignees

@StackScribe StackScribe

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
2.0.0-rc.1
Development

Successfully merging this pull request may close these issues.
3 participants
@StackScribe @odubajDT @RealAnna