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: Start using Read the Docs #324

Merged
merged 13 commits into from
Oct 16, 2023
Merged

docs: Start using Read the Docs #324

merged 13 commits into from
Oct 16, 2023

Conversation

EduardGomezEscandell
Copy link
Contributor

@EduardGomezEscandell EduardGomezEscandell commented Oct 10, 2023

Highly recommended to look commits one by one. You can see a successful build here:
https://canonical-ubuntu-pro-for-windows.readthedocs-hosted.com/en/docs/#

UDENG-1551

@EduardGomezEscandell EduardGomezEscandell self-assigned this Oct 10, 2023
@EduardGomezEscandell EduardGomezEscandell changed the title Start read-the-docs setup docs: start read-the-docs setup Oct 10, 2023
@EduardGomezEscandell EduardGomezEscandell force-pushed the docs branch 4 times, most recently from fd51c25 to 6f45600 Compare October 11, 2023 09:07
@EduardGomezEscandell EduardGomezEscandell marked this pull request as ready for review October 11, 2023 09:19
@EduardGomezEscandell EduardGomezEscandell changed the title docs: start read-the-docs setup docs: Start using Read the Docs Oct 11, 2023
@EduardGomezEscandell EduardGomezEscandell requested review from a team and removed request for a team October 11, 2023 09:36
Copy link
Contributor

@CarlosNihelton CarlosNihelton left a comment

Choose a reason for hiding this comment

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

Just a few details

README.md Show resolved Hide resolved
docs/.wordlist.txt Show resolved Hide resolved
docs/custom_conf.py Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/custom_conf.py Outdated Show resolved Hide resolved
docs/02-install.md Outdated Show resolved Hide resolved
EduardGomezEscandell and others added 11 commits October 11, 2023 15:51
The install document has been split in three.
They don't even pass the spell check :P
When attempting to edit a file on ReadTheDocs, it simply appends
`github_folder` to the file name, so we need the trailing path
separator.
Co-authored-by: Carlos Nihelton <[email protected]>
@EduardGomezEscandell
Copy link
Contributor Author

Force-pushed to rebase main (I also snuck in a typo fix :P).

Copy link
Contributor

@CarlosNihelton CarlosNihelton left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏽

The deb buil CI failure is unrelated (and familiar), while the Go vulnerability checker alert is being handled in PR #338 , thus I think we are done with this.

@EduardGomezEscandell EduardGomezEscandell merged commit 8d35855 into main Oct 16, 2023
29 of 34 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