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] Add change to enable 404 page automation #349

Merged
merged 6 commits into from
Mar 7, 2024
Merged

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Mar 6, 2024

Description

Small change to follow instructions in RTD guide and enable a 404 page. Setting the site_url to the base canonical URL for the docs is sufficient for the tool to build us a 404.html, which we need now I've moved some pages.

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@stichbury stichbury self-assigned this Mar 6, 2024
@stichbury stichbury added the Docs 🗒️ Issue for markdown and API documentation label Mar 6, 2024
@huong-li-nguyen huong-li-nguyen changed the title [docs] Add change to enable 404 page automation [Docs] Add change to enable 404 page automation Mar 6, 2024
@huong-li-nguyen huong-li-nguyen self-requested a review March 6, 2024 10:36
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

Just a clarifying question - after this PR, a link like this: https://vizro.readthedocs.io/en/stable/pages/user_guides/custom_actions/#interacting-with-dashboard-inputs-and-outputs

should now lead to a 404 page right? Because it seems like this section doesn't exist anymore? Ah no wait, this seems to exist, but the forward reference doesn't seem to work with this one?

@stichbury
Copy link
Contributor Author

Just a clarifying question - after this PR, a link like this: https://vizro.readthedocs.io/en/stable/pages/user_guides/custom_actions/#interacting-with-dashboard-inputs-and-outputs

should now lead to a 404 page right? Because it seems like this section doesn't exist anymore? Ah no wait, this seems to exist, but the forward reference doesn't seem to work with this one?

The links to sections within a page should not break a link if the section is renamed or removed. From my testing, if the page exists, it'll be displayed but when the subsection isn't found, it just falls back to show the top of the page.

It sounds like that's another redirect issue, which seems to be ongoing today, but that page may not be in my top 20 list. Maybe I'll just add them all for safety!

Copy link
Contributor

@petar-qb petar-qb left a comment

Choose a reason for hiding this comment

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

Looks good!

@huong-li-nguyen huong-li-nguyen self-requested a review March 6, 2024 12:28
vizro-ai/mkdocs.yml Outdated Show resolved Hide resolved
@huong-li-nguyen huong-li-nguyen merged commit c40eed7 into main Mar 7, 2024
34 checks passed
@huong-li-nguyen huong-li-nguyen deleted the docs/404-page branch March 7, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants