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: add spell-checker to contributing docs #2504

Merged
merged 26 commits into from
Jan 12, 2024
Merged

docs: add spell-checker to contributing docs #2504

merged 26 commits into from
Jan 12, 2024

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Nov 15, 2023 •
edited
Loading

Summary

Adds information about using the spell checker to the Contributing Guide

Fixes #2462
Replaces #2489

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 Nov 15, 2023
@StackScribe StackScribe added this to the 0.10 milestone Nov 15, 2023
@StackScribe StackScribe self-assigned this Nov 15, 2023
@StackScribe StackScribe requested review from a team as code owners November 15, 2023 03:20
@netlify Netlify
Copy link

netlify bot commented Nov 15, 2023 •
edited
Loading

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 6abbb7b
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/65816fcd2a40e0000823a280
😎 Deploy Preview https://deploy-preview-2504--keptn-lifecycle-toolkit.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.

@StackScribe StackScribe mentioned this pull request Nov 15, 2023
Closed
8 tasks
@StackScribe StackScribe marked this pull request as draft November 16, 2023 09:48
@StackScribe StackScribe marked this pull request as ready for review November 27, 2023 06:43
@StackScribe @RealAnna
docs: add spell-checker to contribute/docs
33e5df5 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @RealAnna
internals
b8dbede 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @RealAnna
markdownlint-fix
18ec002 
Signed-off-by: Meg McRoberts <[email protected]>
@RealAnna
Copy link
Contributor

I rebased the branch since there was a Markdown error solved in main

mowies
mowies requested changes Nov 29, 2023
View reviewed changes
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
docs/content/en/contribute/docs/spell-check/_index.md Outdated Show resolved Hide resolved
StackScribe and others added 5 commits November 29, 2023 15:12
@StackScribe @mowies
Update docs/content/en/contribute/docs/spell-check/_index.md
48bde63 
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/content/en/contribute/docs/spell-check/_index.md
210573d 
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/content/en/contribute/docs/spell-check/_index.md
3a013f1 
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/content/en/contribute/docs/spell-check/_index.md
9dbe51d 
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/content/en/contribute/docs/spell-check/_index.md
ef702d3 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
mowies
mowies reviewed Dec 19, 2023
View reviewed changes
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/docs/spell-check.md Outdated Show resolved Hide resolved
StackScribe and others added 7 commits December 19, 2023 03:28
@StackScribe @mowies
Update docs-new/docs/contribute/docs/spell-check.md
fc14889 
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-new/docs/contribute/docs/spell-check.md
66f8e9a 
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-new/docs/contribute/docs/spell-check.md
6546551 
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-new/docs/contribute/docs/spell-check.md
893b3fe 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
spelling error for testing
7d9521f 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
another spelling error for testing
3394164 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe
point to job summary for errors
4a5eeab 
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe @mowies
Update docs-new/docs/contribute/docs/spell-check.md
7dcebbc 
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-new/docs/contribute/docs/spell-check.md
1066918 
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
mowies
mowies previously approved these changes Dec 21, 2023
View reviewed changes
@StackScribe
remove ref to community/slack
5d51c06 
Signed-off-by: Meg McRoberts <[email protected]>
mowies
mowies previously approved these changes Dec 21, 2023
View reviewed changes
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Jan 5, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

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

See analysis details on SonarCloud

@odubajDT odubajDT changed the title docs: add spell-checker to contribute/docs docs: add spell-checker to contributing docs Jan 5, 2024
@StackScribe StackScribe mentioned this pull request Jan 11, 2024
Merged
8 tasks
@odubajDT odubajDT merged commit d2c6f85 into keptn:main Jan 12, 2024
12 checks passed
@keptn-bot keptn-bot mentioned this pull request Jan 23, 2024
Merged
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
@StackScribe @mowies
@odubajDT @Vickysomtee
docs: add spell-checker to contributing docs (keptn#2504)
556e19d 
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Co-authored-by: odubajDT <[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

@mowies mowies mowies left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.10
Development

Successfully merging this pull request may close these issues.

Add info about spell checker to contrib guide
4 participants
@StackScribe @RealAnna @mowies @odubajDT