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

add concepts.rst, fix broken link in code.rst #105

Conversation

nielsenjared
Copy link
Contributor

This PR refers to canonical/open-documentation-academy#78

It adds the missing concepts.rst and fixes the broken link in code.rst.

Running make linkcheck throws the following error:

$HOME/launchpad-manual/explanation/concepts.rst: WARNING: document isn't included in any toctree

Let me know if there's anything I need to do to resolve the error.

@jugmac00
Copy link
Member

jugmac00 commented Sep 5, 2024

@nielsenjared Could you please look into the build failures? It looks like the newly added page adds some spelling errors.

Thank you!

@jugmac00
Copy link
Member

jugmac00 commented Sep 6, 2024

@nielsenjared Sorry, I missed your question about the warning about the newly added file.

Sphinx warns if a file is added to the repo, but not included in any index.

Please add it to the explanation index, as following:

❯ git diff
diff --git a/explanation/index.rst b/explanation/index.rst
index d29d619..b82970e 100644
--- a/explanation/index.rst
+++ b/explanation/index.rst
@@ -38,6 +38,7 @@ General
    error-explanations
    security-policy
    xxx-policy
+   concepts
 
 JavaScript
 ----------

Thank you!

P.S.: We have enabled the strict setting, so readthedocs breaks on warnings, which imho is a very good thing, as warnings sometimes can lead to unexpected behavior.

@jugmac00 jugmac00 merged commit ce5408a into canonical:main Sep 12, 2024
2 checks passed
nbarbarick pushed a commit to nbarbarick/launchpad-manual that referenced this pull request Sep 15, 2024
* add concepts.rst, fix broken link in code.rst

* add spellcheck errors to custom_wordlist

* add concepts to index.rst
alvaro-crespo pushed a commit that referenced this pull request Sep 30, 2024
* Remove How to go about writing a web application, per jugmac00.

* Group articles in the Explanation section into subsections, add introductory text.

* Add new sections for remaining ToC headings.

* Add codehosting.png, fix broken link (#104)

* add codehosting.png, fix broken link

* delete linkcheck_ignore item

* remove accessibility, upstream, and schema links (#102)

* add concepts.rst, fix broken link in code.rst (#105)

* add concepts.rst, fix broken link in code.rst

* add spellcheck errors to custom_wordlist

* add concepts to index.rst

* Add descriptions in the explanation index and move new concepts page.

---------

Co-authored-by: Jared Nielsen <[email protected]>
@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