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

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

Merged
merged 10 commits into from
Feb 2, 2024

Conversation

shriyakalakata
Copy link
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
Copy link
Member

Thanks for taking this on!
This PR needs to be rebased against the current version of main:
https://matplotlib.org/devdocs/devel/development_workflow.html#rebase-onto-upstream-main

And I'm pretty sure the paths of all the license files need to be updated now that they've been moved up a level.

@story645
Copy link
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
Copy link
Member

story645 commented Jan 10, 2024

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
Copy link
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:

@shriyakalakata
Copy link
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
Copy link
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
Copy link
Member

story645 commented Jan 10, 2024

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.

Copy link
Member

@story645 story645 left a comment

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
Copy link
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
Copy link
Member

QuLogic commented Jan 11, 2024

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
Copy link
Member

@shriyakalakata just to clarify, you need to run tools/cache_zenodo_svg.py and then commit the output to replace the current output as the doc build is failing on

/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/10059757.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/8347255.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/8336761.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/8118151.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7697899.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7637593.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7527665.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7275322.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7162185.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/7084615.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/6982547.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/6513224.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/5773480.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/5706396.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/5194481.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4743323.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4649959.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4638398.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4475376.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4268928.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/4030140.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3984190.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3948793.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3898017.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3714460.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3695547.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3633844.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3563226.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3264781.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/2893252.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/2577644.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1482099.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1482098.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/3633833.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1420605.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/2669103.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1343133.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1202077.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1202050.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1189358.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1154287.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1098480.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/1004650.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/573577.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/570311.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/248351.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/61948.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/56926.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/44579.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/32914.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/15423.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/12400.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/12287.svg
/home/circleci/project/doc/project/citing.rst:: WARNING: image file not readable: ../_static/zenodo_cache/11451.svg
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done

@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
Copy link
Member

@story645 story645 left a comment

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
35 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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