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

docs: Improve getting-started.md documentation #1094

Merged
merged 1 commit into from
Feb 21, 2025

Conversation

Ninfa-Jeon
Copy link
Contributor

This commit updates the getting-started guide to fix spelling and grammatical errors. The changes include:

  • Correcting typos
  • Adding punctuation to fix grammatical mistakes throughout the document

@Ninfa-Jeon Ninfa-Jeon requested a review from a team as a code owner February 20, 2025 18:45
@Ninfa-Jeon
Copy link
Contributor Author

Hi, I have signed the CLA but I'm unable to re-run the pipeline.

@nhennigan
Copy link
Contributor

Hi @Ninfa-Jeon thanks for contributing! I re-reran the CLA check and it does not seem to have updated yet. Did you sign it recently? Do you have issues contributing to any other Canonical repos?

The documentation check that is failing is a broken link on a different page that I am fixing so that should pass on your next push. The markdown lint is a genuine error though. We try to keep line length less than 80 characters to make it easier to read. 😸

@Ninfa-Jeon
Copy link
Contributor Author

Hi @Ninfa-Jeon thanks for contributing! I re-reran the CLA check and it does not seem to have updated yet. Did you sign it recently? Do you have issues contributing to any other Canonical repos?

The documentation check that is failing is a broken link on a different page that I am fixing so that should pass on your next push. The markdown lint is a genuine error though. We try to keep line length less than 80 characters to make it easier to read. 😸

Hi @nhennigan thank you for your reply. Yes I just signed it yesterday after seeing this issue and I've faced similar issue on another repo but not on the one my team works with. Do you think I missed something? Additionally, will try to fix the character length-related issue in my next push <3

@Ninfa-Jeon Ninfa-Jeon force-pushed the patch-1 branch 3 times, most recently from dad22dc to 100f98f Compare February 21, 2025 05:46
This commit updates the getting-started guide to fix spelling and grammatical errors. The changes include:

* Correcting typos
* Adding punctuation to fix grammatical mistakes throughout the document
@Ninfa-Jeon
Copy link
Contributor Author

After some trial and error I fixed the CI...

@nhennigan nhennigan merged commit 37d0ad7 into canonical:main Feb 21, 2025
5 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.

2 participants