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

Check Spelling errors (Storm migration guide) #92

Merged
merged 3 commits into from
Jul 23, 2024

Conversation

sfadriaan
Copy link
Contributor

As per the issue raised in the Open Documentation Academy (Issue canonical/open-documentation-academy#77), the page "Database Performance" was removed from the exclusion list and make spelling was run to include it in the spell checker.

Some comments with regards to the changes:

  • A lot of inline code was incorrectly formatted which resulted in the code snippets popping up as spelling errors. The formatting was corrected which removed them from being checked by the spell checker
  • The "Questions" section's formatting was inconsistent and was standardized throughout the section

I am also not quite convinced on the formatting of the section "Tips on Converting Tests", but left it as is, as I assume it will be addressed when there is a comprehensive review of the documentation.

Thanks

Copy link
Member

@jugmac00 jugmac00 left a comment

Choose a reason for hiding this comment

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

Thank you!

@jugmac00 jugmac00 merged commit ff237fe into canonical:main Jul 23, 2024
2 checks passed
@sfadriaan sfadriaan deleted the storm-migration-guide branch July 23, 2024 12:45
@jugmac00 jugmac00 added the Open Documentation Academy Community contribution via https://canonical.com/documentation/open-documentation-academy label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Open Documentation Academy Community contribution via https://canonical.com/documentation/open-documentation-academy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants