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

Update documentation #216

Merged
merged 2 commits into from
Jan 12, 2024
Merged

Update documentation #216

merged 2 commits into from
Jan 12, 2024

Conversation

agileshaw
Copy link
Contributor

  • Mark non-referenced rst files as orphans. These files are part of the starter pack repo and without the orphan tag, it causes compile error on RTD)
  • Use terminal block for show the output of a or a series of command(s)
  • Update section headings following RST stype guide

- Mark non-referenced rst files as orphans. These files are part of
the starter pack repo and without the `orphan` tag, it causes compile
error on RTD)
- Use `terminal` block for show the output of a or a series of command(s)
- Update section heading characters following RST stype guide
@agileshaw agileshaw requested a review from a team as a code owner January 12, 2024 01:08
docs/how-to/upgrade-cloud.rst Outdated Show resolved Hide resolved
docs/how-to/upgrade-cloud.rst Outdated Show resolved Hide resolved
@agileshaw agileshaw requested a review from aieri January 12, 2024 03:07
Copy link
Contributor

@rgildein rgildein left a comment

Choose a reason for hiding this comment

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

LGTM

@agileshaw agileshaw merged commit f8ec12f into canonical:main Jan 12, 2024
2 checks passed
@agileshaw agileshaw deleted the fix-RTD-issues branch January 12, 2024 13:45
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.

4 participants