-
Notifications
You must be signed in to change notification settings - Fork 117
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
[Ready] Rename docs to remove underscores, fix resulting broken links #321
Conversation
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
for more information, see https://pre-commit.ci
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
I think you need to add another changelog file under vizro-core! You've already done so for vizro-ai, but because you have changes in vizro-core as well, you need to add a second changelog file there!
Just run this command from the directoy of vizro-core: hatch run changelog:add
I've proposed a code change below to fix the remaining linting issue :)
Co-authored-by: Li Nguyen <90609403+huong-li-nguyen@users.noreply.github.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Li Nguyen <90609403+huong-li-nguyen@users.noreply.github.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
for more information, see https://pre-commit.ci
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
…mckinsey/vizro into second-branch-docs-name-changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm - would remove the changelog entries (not the files ;) )
vizro-ai/changelog.d/20240220_115353_jo_stichbury_second_branch_docs_name_changes.md
Outdated
Show resolved
Hide resolved
vizro-core/changelog.d/20240220_140357_jo_stichbury_second_branch_docs_name_changes.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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
|
@stichbury is there any harm in putting all those redirects in place right now? So that:
Also, as per my comment in #313, I'm very happy to just have the most important redirects if adding all of them is more effort than it's worth. |
I'm not sure -- we could put in some redirects for |
Merging this anyway, we can figure out redirects separately! |
Redirects for pages are the priority, in order of most-least :
|
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
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":