Add project documentation contents to be displayed on RTD #210

agileshaw · 2024-01-06T03:05:18Z

This PR add contents of the project documentation to docs/ to be displayed on RTD site.

Notes to reviewers: to see how the documentation looks like, please follow these steps:

In terminal:

git clone https://github.com/agileshaw/charmed-openstack-upgrader -b add-docs-content
cd charmed-openstack-upgrader/docs
make run  # active an virtual env and serve documentation on 127.0.0.1:8000

In browser:
- access 127.0.0.1:8000

Set up documentation integration with RTD using sphinx-docs-starter-pack following the instruction: https://github.com/canonical/sphinx-docs-starter-pack#documentation-in-a-code-repository

docs/.custom_wordlist.txt

docs/explanation/planning.rst

docs/explanation/upgrade.rst

docs/how-to/non-interactive.rst

docs/how-to/index.rst

docs/how-to/no-backup.rst

docs/how-to/non-interactive.rst

docs/explanation/upgrade.rst

docs/explanation/known-issues.rst

docs/how-to/no-backup.rst

docs/explanation/known-issues.rst

docs/explanation/upgrade.rst

docs/how-to/different-model.rst

docs/how-to/upgrade-cloud.rst

docs/get-started/index.rst

rgildein

LGTM

aieri

LGTM, just one small comment

docs/get-started/index.rst

gabrielcocenza

LGTM

agileshaw added 9 commits January 5, 2024 09:53

Initial setup for RTD Integration

2fe886b

Set up documentation integration with RTD using sphinx-docs-starter-pack following the instruction: https://github.com/canonical/sphinx-docs-starter-pack#documentation-in-a-code-repository

Exclude docs directory in lint tests

ae66426

Include docs directory for spell check

a56fb31

Add configuration

dbd32c4

Update custom wordlist

81f0433

Use only one spell check for docs

f40c47e

Add documentation for RTD

d67e7ce

Merge branch 'main' into add-docs-content

42aba1a

Add project documentation to be displayed in RTD

ae71fc4

agileshaw requested a review from a team as a code owner January 6, 2024 03:05

agileshaw requested review from Pjack, aieri, jneo8 and rgildein January 6, 2024 03:05

agileshaw self-assigned this Jan 6, 2024

gabrielcocenza requested changes Jan 8, 2024

View reviewed changes

Address review comments

c4f131e

agileshaw requested a review from gabrielcocenza January 8, 2024 18:41

aieri requested changes Jan 8, 2024

View reviewed changes

gabrielcocenza requested changes Jan 8, 2024

View reviewed changes

docs/how-to/no-backup.rst Outdated Show resolved Hide resolved

docs/how-to/no-backup.rst Outdated Show resolved Hide resolved

rgildein requested changes Jan 8, 2024

View reviewed changes

agileshaw requested review from aieri, rgildein and gabrielcocenza January 9, 2024 00:46

Update documentation according to suggestions

36772a1

agileshaw force-pushed the add-docs-content branch from 06bb340 to 36772a1 Compare January 9, 2024 22:00

aieri requested changes Jan 9, 2024

View reviewed changes

docs/get-started/index.rst Outdated Show resolved Hide resolved

rgildein previously approved these changes Jan 10, 2024

View reviewed changes

Adjust wording for user access level

03b4c73

agileshaw dismissed rgildein’s stale review via 03b4c73 January 10, 2024 19:52

agileshaw requested review from aieri and rgildein January 10, 2024 19:52

aieri requested changes Jan 10, 2024

View reviewed changes

docs/get-started/index.rst Outdated Show resolved Hide resolved

Small wording fix

7e91d7b

agileshaw requested a review from aieri January 11, 2024 02:33

gabrielcocenza approved these changes Jan 11, 2024

View reviewed changes

rgildein approved these changes Jan 11, 2024

View reviewed changes

aieri approved these changes Jan 11, 2024

View reviewed changes

agileshaw merged commit 41a773b into canonical:main Jan 11, 2024
4 checks passed

agileshaw deleted the add-docs-content branch January 11, 2024 16:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add project documentation contents to be displayed on RTD #210

Add project documentation contents to be displayed on RTD #210

agileshaw commented Jan 6, 2024

rgildein left a comment

aieri left a comment

gabrielcocenza left a comment

Add project documentation contents to be displayed on RTD #210

Add project documentation contents to be displayed on RTD #210

Conversation

agileshaw commented Jan 6, 2024

rgildein left a comment

Choose a reason for hiding this comment

aieri left a comment

Choose a reason for hiding this comment

gabrielcocenza left a comment

Choose a reason for hiding this comment