search

canonical / mir-server.io

The codebase for the https://mir-server.io website
9 stars 28 forks source link

Update /doc to new documentation site #245

Closed carkod closed 4 months ago

carkod commented 4 months ago

Done

Drive-by:

QA

Issue

Fixes https://warthogs.atlassian.net/browse/WD-11975 Fixes https://github.com/canonical/mir-server.io/issues/234 Fixes https://github.com/canonical/mir-server.io/issues/78

webteam-app commented 4 months ago

Demo

Jenkins

demos.haus

Saviq commented 4 months ago

@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 commented 4 months ago

@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 commented 4 months ago

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.