Moved /users/project to /doc/project by shriyakalakata · Pull Request #27560 · matplotlib/matplotlib · GitHub
Skip to content

Moved /users/project to /doc/project - #27560

Merged
QuLogic merged 10 commits into
matplotlib:mainfrom
shriyakalakata:user_guide_docs
Feb 2, 2024
Merged

Moved /users/project to /doc/project#27560
QuLogic merged 10 commits into
matplotlib:mainfrom
shriyakalakata:user_guide_docs

Conversation

@shriyakalakata

@shriyakalakata shriyakalakata commented Dec 23, 2023

Copy link
Copy Markdown
Contributor

PR summary

This PR addresses the issue #27396 on moving non user guide related content out of /users. This is the first step, moving /users/project -> /doc/project and adding redirects.

PR checklist

@story645

story645 commented Dec 24, 2023

Copy link
Copy Markdown
Member

@story645

story645 commented Jan 10, 2024

Copy link
Copy Markdown
Member

Awesome, am waiting on doc build to check all the links.
Can you please also update https://github.com/matplotlib/matplotlib/blob/main/doc/devel/contribute.rst#contribute-documentation ?

@story645

story645 commented Jan 10, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Awesome that you caught the pre-commit. Doing a small git grep users/project these were the other paths/urls that should be changed: (urls should still work b/c of redirects but may as well do the updates together).
(mpl-dev) C:\Users\story\Projects\matplotlib>git grep "users/project"

And the docs readme that's already slightly out of date

@story645

story645 commented Jan 10, 2024

Copy link
Copy Markdown
Member

Also let me know if you'd like to do the updates to the brochure site or if you'd like me to. Again, b/c of the redirects the urls should still work, so it shouldn't be urgent:

@story645 story645 added this to the v3.9.0 milestone Jan 10, 2024
@story645 story645 mentioned this pull request Jan 10, 2024
Merged
@shriyakalakata
shriyakalakata marked this pull request as draft January 10, 2024 18:31
@shriyakalakata

shriyakalakata commented Jan 10, 2024

Copy link
Copy Markdown
Contributor Author

Doing a small git grep users/project these were the other paths/urls that should be changed

I previously changed the ones with doc/users/project. I just now changed the ones with users/project as well

@shriyakalakata

shriyakalakata commented Jan 10, 2024

Copy link
Copy Markdown
Contributor Author

Also let me know if you'd like to do the updates to the brochure site or if you'd like me to. Again, b/c of the redirects the urls should still work, so it shouldn't be urgent:

If it's easier for you to do it because it's in a different repo, sure. If not, I can do it as well

@story645

story645 commented Jan 10, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

If it's easier for you to do it because it's in a different repo, sure. If not, I can do it as well

More like if it's something you want to do, go for it; otherwise, I'll take care of it.

story645
story645 requested changes Jan 10, 2024
View reviewed changes

@story645 story645 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

docs aren't building b/c the relative path to ../static changed and that's breaking the zonedo stuff, and not sure if it's better to rerun the autogen script or to manually edit. Maybe @QuLogic knows?

@shriyakalakata shriyakalakata mentioned this pull request Jan 11, 2024
Merged
@shriyakalakata

shriyakalakata commented Jan 11, 2024

Copy link
Copy Markdown
Contributor Author

let me know if you'd like to do the updates to the brochure site or if you'd like me to.

More like if it's something you want to do, go for it; otherwise, I'll take care of it.

Sure! I've made the changes in this PR

@QuLogic

QuLogic commented Jan 11, 2024

Copy link
Copy Markdown
Member

docs aren't building b/c the relative path to ../static changed and that's breaking the zonedo stuff, and not sure if it's better to rerun the autogen script or to manually edit. Maybe @QuLogic knows?

Yes, it's probably easiest to edit tools/cache_zenodo_svg.py and re-run it.

@story645

story645 commented Jan 17, 2024

Copy link
Copy Markdown
Member

@github-actions github-actions Bot added the Documentation: devdocs files in doc/devel label Jan 26, 2024
@shriyakalakata
shriyakalakata marked this pull request as ready for review January 29, 2024 22:09
@story645 story645 mentioned this pull request Jan 29, 2024
Open
10 tasks
story645
story645 approved these changes Jan 29, 2024
View reviewed changes

@story645 story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So can be done in a follow up, but credits.rst is generated from https://github.com/matplotlib/matplotlib/blob/main/doc/users/generate_credits.py so maybe that file can be moved either here or into tools? and the redirects added to that file?

@QuLogic
QuLogic merged commit 968e554 into matplotlib:main Feb 2, 2024
@story645 story645 mentioned this pull request Feb 4, 2024
Closed
@story645 story645 mentioned this pull request Feb 29, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@story645 story645 story645 approved these changes

Assignees

No one assigned

Labels

Documentation: devdocs files in doc/devel Documentation

Projects

None yet

Milestone

v3.9.0

Development

Successfully merging this pull request may close these issues.

[Doc]: Move non user guide related content out of /users

3 participants

@shriyakalakata @story645 @QuLogic