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 /doc to new documentation site #245

Merged
merged 3 commits into from
Jun 13, 2024
Merged

Update /doc to new documentation site #245

merged 3 commits into from
Jun 13, 2024

Conversation

carkod
Copy link
Contributor

@carkod carkod commented Jun 10, 2024

Done

Drive-by:

  • Fixed dotrun and updated checkout action

QA

Issue

Fixes https://warthogs.atlassian.net/browse/WD-11975
Fixes #234
Fixes #78

@webteam-app
Copy link
Collaborator

@Saviq
Copy link
Contributor

Saviq commented Jun 10, 2024

@carkod here's the desired mapping:

/doc?: https://canonical-mir.readthedocs-hosted.com/stable/
/doc/cppguide?: https://canonical-mir.readthedocs-hosted.com/stable/_static/cppguide/
/doc/component_reports.html: https://canonical-mir.readthedocs-hosted.com/stable/explanation/component_reports/
/doc/dso_versioning_guide.html: https://canonical-mir.readthedocs-hosted.com/stable/reference/dso_versioning_guide/
/doc/getting_and_using_mir.html: https://canonical-mir.readthedocs-hosted.com/stable/tutorial/
/doc/getting_involved_in_mir.html: https://canonical-mir.readthedocs-hosted.com/stable/how-to/getting_involved_in_mir/
/doc/introducing_the_miral_api.html: https://canonical-mir.readthedocs-hosted.com/stable/reference/introducing_the_miral_api/
/doc/md_doc_kernel_requirements.html: https://canonical-mir.readthedocs-hosted.com/stable/reference/kernel_requirements/
/doc/deprecated.html: https://canonical-mir.readthedocs-hosted.com/stable/api/page_deprecated/
/doc/md__h_a_c_k_i_n_g.html: https://github.com/canonical/mir/blob/main/HACKING.md
/doc/md__r_e_a_d_m_e.html: https://github.com/canonical/mir/blob/main/README.md

Not sure about the first couple - basically /doc/cppguide* should redirect to the cppguide page, and anything not listed explicitly should redirect to the main new doc page.

@Saviq
Copy link
Contributor

Saviq commented Jun 12, 2024

@carkod this doesn't seem to be doing it all:

https://mir-server-io-245.demos.haus/doc/cppguide/index.html does not redirect
https://mir-server-io-245.demos.haus/doc/foo does a 404

We should also drop the static doc from this repo.

@carkod
Copy link
Contributor Author

carkod commented Jun 12, 2024

cppguide/index.html

Done. Except /doc/foo, isn't this the correct behavior? If a page doesn't exist surely it shouldn't be redirected to some other page.

@carkod carkod merged commit ca6b88e into main Jun 13, 2024
7 checks passed
@carkod carkod deleted the update-doc-wd-11975 branch June 13, 2024 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Redirect from /doc/** to readthedocs No way back to homepage from User-manual-page
4 participants