[Ready] Rename docs to remove underscores, fix resulting broken links

stichbury commented 4 months ago

Description

This PR changes names as #313 describes. Docs are building as expected (see https://vizro-ai--321.org.readthedocs.build/en/321/ for example) and all link warnings are now resolved.

HOWEVER, there's a linter issue I'm struggling to resolve.

Screenshot

Notice

[x] 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 commented 4 months ago

Here is a list of the pages I changed -- when we make the next release we should decide which of these should be redirected in the RTD console (to help people with stored links or blog posts etc that link to the old _ names).


vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md
--> vizro-ai/docs/pages/explanation/safety-in-vizro-ai.md
vizro-ai/docs/pages/tutorials/explore_vizro_ai.md
--> vizro-ai/docs/pages/tutorials/explore-vizro-ai.md
vizro-ai/docs/pages/user_guides/api_setup.md
--> vizro-ai/docs/pages/user-guides/api-setup.md
vizro-ai/docs/pages/user_guides/install.md
--> vizro-ai/docs/pages/user-guides/install.md
vizro-ai/docs/pages/user_guides/model_config.md
--> vizro-ai/docs/pages/user-guides/model-config.md
vizro-ai/docs/pages/user_guides/run_vizro_ai.md
--> vizro-ai/docs/pages/user-guides/run-vizro-ai.md

vizro-core/docs/pages/API_reference/actions.md
--> vizro-core/docs/pages/API-reference/actions.md
vizro-core/docs/pages/API_reference/manager.md
--> vizro-core/docs/pages/API-reference/manager.md
vizro-core/docs/pages/API_reference/models.md
--> vizro-core/docs/pages/API-reference/models.md
vizro-core/docs/pages/API_reference/vizro.md
--> vizro-core/docs/pages/API-reference/vizro.md
vizro-core/docs/pages/explanation/why_vizro.md
--> vizro-core/docs/pages/explanation/why-vizro.md
vizro-core/docs/pages/tutorials/explore_components.md
--> vizro-core/docs/pages/tutorials/explore-components.md
vizro-core/docs/pages/tutorials/first_dashboard.md
--> vizro-core/docs/pages/tutorials/first-dashboard.md
vizro-core/docs/pages/user_guides/actions.md
--> vizro-core/docs/pages/user-guides/actions.md
vizro-core/docs/pages/user_guides/assets.md
--> vizro-core/docs/pages/user-guides/assets.md
vizro-core/docs/pages/user_guides/card_button.md
--> vizro-core/docs/pages/user-guides/card-button.md
vizro-core/docs/pages/user_guides/components.md
--> vizro-core/docs/pages/user-guides/components.md
vizro-core/docs/pages/user_guides/container.md
--> vizro-core/docs/pages/user-guides/container.md
vizro-core/docs/pages/user_guides/custom_actions.md
--> vizro-core/docs/pages/user-guides/custom-actions.md
vizro-core/docs/pages/user_guides/custom_charts.md
--> vizro-core/docs/pages/user-guides/custom-charts.md
vizro-core/docs/pages/user_guides/custom_components.md
--> vizro-core/docs/pages/user-guides/custom-components.md
vizro-core/docs/pages/user_guides/custom_tables.md
--> vizro-core/docs/pages/user-guides/custom-tables.md
vizro-core/docs/pages/user_guides/dashboard.md
--> vizro-core/docs/pages/user-guides/dashboard.md
vizro-core/docs/pages/user_guides/data.md
--> vizro-core/docs/pages/user-guides/data.md
vizro-core/docs/pages/user_guides/filters.md
--> vizro-core/docs/pages/user-guides/filters.md
vizro-core/docs/pages/user_guides/graph.md
--> vizro-core/docs/pages/user-guides/graph.md
vizro-core/docs/pages/user_guides/install.md
--> vizro-core/docs/pages/user-guides/install.md
vizro-core/docs/pages/user_guides/integration.md
--> vizro-core/docs/pages/user-guides/integration.md
vizro-core/docs/pages/user_guides/layouts.md
--> vizro-core/docs/pages/user-guides/layouts.md
vizro-core/docs/pages/user_guides/navigation.md
--> vizro-core/docs/pages/user-guides/navigation.md
vizro-core/docs/pages/user_guides/pages.md
--> vizro-core/docs/pages/user-guides/pages.md
vizro-core/docs/pages/user_guides/parameters.md
--> vizro-core/docs/pages/user-guides/parameters.md
vizro-core/docs/pages/user_guides/run.md
--> vizro-core/docs/pages/user-guides/run.md
vizro-core/docs/pages/user_guides/selectors.md
--> vizro-core/docs/pages/user-guides/selectors.md
vizro-core/docs/pages/user_guides/table.md
--> vizro-core/docs/pages/user-guides/table.md
vizro-core/docs/pages/user_guides/tabs.md
--> vizro-core/docs/pages/user-guides/tabs.md
vizro-core/docs/pages/user_guides/themes.md
--> vizro-core/docs/pages/user-guides/themes.md

antonymilne commented 4 months ago

@stichbury is there any harm in putting all those redirects in place right now? So that:

we're not blocking a release waiting for it
we can start updating links already, e.g. in my post on the plotly forums

Also, as per my comment in https://github.com/mckinsey/vizro/issues/313, I'm very happy to just have the most important redirects if adding all of them is more effort than it's worth.

stichbury commented 4 months ago

@stichbury is there any harm in putting all those redirects in place right now?

I'm not sure -- we could put in some redirects for latest I suppose but we'd have to adjust them at release anyway, since otherwise we end up redirecting everything (including stable) to latest and probably don't want to do that?

stichbury commented 4 months ago

Merging this anyway, we can figure out redirects separately!

stichbury commented 4 months ago

Redirects for pages are the priority, in order of most-least :

[x] /pages/tutorials/first_dashboard/
[x] /pages/tutorials/explore_components/
[x] /pages/explanation/why_vizro/
[x] /pages/API_reference/models/
[x] /pages/user_guides/table/
[x] /pages/API_reference/vizro/
[x] /pages/user_guides/layouts/
[x] /pages/user_guides/run/
[x] /pages/user_guides/custom_charts/
[x] /pages/user_guides/pages/
[x] /pages/user_guides/components/
[x] /pages/user_guides/data/
[x] /pages/user_guides/custom_components/
[x] /pages/user_guides/navigation/
[x] /pages/user_guides/assets/
[x] /pages/user_guides/custom_actions/
[x] /pages/user_guides/actions/
[x] /pages/user_guides/install/
[x] /pages/API_reference/actions/
[x] /pages/user_guides/integration/
[x] /pages/user_guides/selectors/
[x] /pages/user_guides/custom_tables/
[x] /pages/API_reference/manager/
[x] /pages/user_guides/tabs/
[x] /pages/user_guides/card_button/
[x] /pages/user_guides/container/
[x] /pages/user_guides/dashboard/
[x] /pages/user_guides/filters/
[x] /pages/user_guides/graph/
[x] /pages/user_guides/parameters/
[x] /pages/user_guides/themes/

mckinsey / vizro