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

DNM: POC for LP user documentation #112

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

keirthana
Copy link

This PR demonstrates how to set up a TOC that has display both the LP dev documentation and LP user documentation.
It also has 4 landing pages that has suggestions of a possible TOC and some comments for implementing the TOC.

This PR is purely for demonstration purpose and should not be merged directly.
The individual topics need to be reworked based on the suggested TOC for the user docs to be available at the same level as dev docs.

@jugmac00
Copy link
Member

Thanks a lot for the POC!

When I try to run the run the project via make run I get a number of errors, see

❯ make run
. .sphinx/venv/bin/activate; sphinx-autobuild -b dirhtml "." "_build" \
-c . -d .sphinx/.doctrees
[sphinx-autobuild] > sphinx-build -b dirhtml -d .sphinx/.doctrees -c . /home/jugmac00/src/canonical/launchpad-manual /home/jugmac00/src/canonical/launchpad-manual/_build
Running Sphinx v7.1.2
matplotlib is not installed, social cards will not be generated
loading pickled environment... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'deflist'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [dirhtml]: targets for 1 source files that are out of date
updating environment: [config changed ('redirects')] 105 added, 0 changed, 93 removed
reading sources... [100%] using-launchpad/tutorials/index
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/branches.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/code.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/css.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/css-sprites.rst:5: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/database-performance.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/datetime-usage.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/engineering-overview-translations.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/feature-flags.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/hacking.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/javascript-buildsystem.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/launchpad-ppa.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/live-patching.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/mail.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/malone.rst:5: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/navigation-menus.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/pre-merge-reviews.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/registry.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/security-policy.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/storm-migration-guide.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/template-reuse.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/testing.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/url-traversal.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/webapp-process.rst:7: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/xxx-policy.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/chameleon.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/database-schema-changes-process.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/database-setup.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/fixing-bugs.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/getting.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/triage-bugs.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/use-soyuz-locally.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:22: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:32: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:66: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:4: WARNING: Duplicate explicit target name: "answer tracker".
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/how-to/index.rst:47: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/how-to/index.rst:51: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/badgekit.rst:19: WARNING: Title underline too short.

How to Display a Badge
---------------------
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/index.rst:19: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/index.rst:4: WARNING: Duplicate explicit target name: "privacy and confidentiality".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/jugmac00/src/canonical/launchpad-manual/includes/important_not_revised.rst: WARNING: document isn't included in any toctree
/home/jugmac00/src/canonical/launchpad-manual/includes/important_out_of_date.rst: WARNING: document isn't included in any toctree
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/badgekit.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] using-launchpad/tutorials/index
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/mail.rst:23: WARNING: unknown document: '../help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/fixing-bugs.rst:25: WARNING: unknown document: '../help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/index.rst:59: WARNING: unknown document: 'help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/index.rst:61: WARNING: unknown document: 'contribute-to-our-docs'
/home/jugmac00/src/canonical/launchpad-manual/index.rst:43: WARNING: unknown document: 'how-to/contributing-changes'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:59: WARNING: unknown document: 'help'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:60: WARNING: unknown document: 'how-to/contributing-changes'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:61: WARNING: unknown document: 'contribute-to-our-docs'
generating indices... genindex done

Extension error (sphinx_reredirects):
Handler <function init at 0x7fe43115c430> for event 'html-collect-pages' threw an exception (exception: '/tutorials/index.html' does not start with '/home/jugmac00/src/canonical/launchpad-manual/_build')
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
[I 240926 12:42:35 server:335] Serving on http://127.0.0.1:8000
[I 240926 12:42:35 handlers:62] Start watching changes
[I 240926 12:42:35 handlers:64] Start detecting changes

Luckily, the generation of the document still works.

The navigation looks clean and intuitive! Thanks so much for working on this!
Screenshot from 2024-09-26 12-45-34

I think we could put a link behind the "We have documentation for Launchpad users and developers." statement.
Screenshot from 2024-09-26 12-47-17

Let's discuss details in the upcoming meeting.

@keirthana
Copy link
Author

Thanks a lot for the POC!

When I try to run the run the project via make run I get a number of errors, see

Yes, that is expected. This PR should not be merged as is but treated as a demonstration of how we can structure content. That's the reason I kept it in draft state and added DNM(Do Not Merge) in the commit message.

IMO, cleaning up those .rst files and adding them to their appropriate folders will need to be done by the LP team members who have the knowledge on whether the content is relevant/up to date/accurate. Once that is done, the structure can be built as per the suggested TOC.

❯ make run
. .sphinx/venv/bin/activate; sphinx-autobuild -b dirhtml "." "_build" \
-c . -d .sphinx/.doctrees
[sphinx-autobuild] > sphinx-build -b dirhtml -d .sphinx/.doctrees -c . /home/jugmac00/src/canonical/launchpad-manual /home/jugmac00/src/canonical/launchpad-manual/_build
Running Sphinx v7.1.2
matplotlib is not installed, social cards will not be generated
loading pickled environment... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'deflist'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [dirhtml]: targets for 1 source files that are out of date
updating environment: [config changed ('redirects')] 105 added, 0 changed, 93 removed
reading sources... [100%] using-launchpad/tutorials/index
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/branches.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/code.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/css.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/css-sprites.rst:5: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/database-performance.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/datetime-usage.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/engineering-overview-translations.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/feature-flags.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/hacking.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/javascript-buildsystem.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/launchpad-ppa.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/live-patching.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/mail.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/malone.rst:5: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/navigation-menus.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/pre-merge-reviews.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/registry.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/security-policy.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/storm-migration-guide.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/template-reuse.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/testing.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/url-traversal.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/webapp-process.rst:7: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/xxx-policy.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/chameleon.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_out_of_date.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/database-schema-changes-process.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/database-setup.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/fixing-bugs.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/getting.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/triage-bugs.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/use-soyuz-locally.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'developing-launchpad/includes/important_not_revised.rst'.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:22: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:32: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:66: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/explanation/index.rst:4: WARNING: Duplicate explicit target name: "answer tracker".
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/how-to/index.rst:47: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/how-to/index.rst:51: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/badgekit.rst:19: WARNING: Title underline too short.

How to Display a Badge
---------------------
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/index.rst:19: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/index.rst:4: WARNING: Duplicate explicit target name: "privacy and confidentiality".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/jugmac00/src/canonical/launchpad-manual/includes/important_not_revised.rst: WARNING: document isn't included in any toctree
/home/jugmac00/src/canonical/launchpad-manual/includes/important_out_of_date.rst: WARNING: document isn't included in any toctree
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/reference/badgekit.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] using-launchpad/tutorials/index
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/explanation/mail.rst:23: WARNING: unknown document: '../help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/how-to/fixing-bugs.rst:25: WARNING: unknown document: '../help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/index.rst:59: WARNING: unknown document: 'help'
/home/jugmac00/src/canonical/launchpad-manual/developing-launchpad/index.rst:61: WARNING: unknown document: 'contribute-to-our-docs'
/home/jugmac00/src/canonical/launchpad-manual/index.rst:43: WARNING: unknown document: 'how-to/contributing-changes'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:59: WARNING: unknown document: 'help'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:60: WARNING: unknown document: 'how-to/contributing-changes'
/home/jugmac00/src/canonical/launchpad-manual/using-launchpad/index.rst:61: WARNING: unknown document: 'contribute-to-our-docs'
generating indices... genindex done

Extension error (sphinx_reredirects):
Handler <function init at 0x7fe43115c430> for event 'html-collect-pages' threw an exception (exception: '/tutorials/index.html' does not start with '/home/jugmac00/src/canonical/launchpad-manual/_build')
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
[I 240926 12:42:35 server:335] Serving on http://127.0.0.1:8000
[I 240926 12:42:35 handlers:62] Start watching changes
[I 240926 12:42:35 handlers:64] Start detecting changes

Luckily, the generation of the document still works.

The navigation looks clean and intuitive! Thanks so much for working on this! Screenshot from 2024-09-26 12-45-34

I think we could put a link behind the "We have documentation for Launchpad users and developers." statement. Screenshot from 2024-09-26 12-47-17

Let's discuss details in the upcoming meeting.

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