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

shriyakalakata · 2023-12-23T03:09:40Z

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

"closes [Doc]: Move non user guide related content out of /users #27396"
[N/A] new and changed code is tested
[N/A] Plotting related features are demonstrated in an example
[N/A] New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

story645 · 2023-12-24T04:52:30Z

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 · 2024-01-10T16:36:41Z

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 · 2024-01-10T17:27:36Z

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"

CODE_OF_CONDUCT.md:https://matplotlib.org/stable/users/project/code_of_conduct.html
CODE_OF_CONDUCT.md:It is rendered from doc/users/project/code_of_conduct.rst
README.md:entry](https://matplotlib.org/stable/users/project/citing.html) is
CODE_OF_CONDUCT.md:https://matplotlib.org/stable/users/project/code_of_conduct.html
CODE_OF_CONDUCT.md:It is rendered from doc/users/project/code_of_conduct.rst
README.md:entry](https://matplotlib.org/stable/users/project/citing.html) is
doc/devel/contribute.rst:please follow the :doc:/users/project/citing guidelines.
- I suggest adding a .. _citing anchor to citing.rst and then changing this to :ref:citing
doc/devel/release_guide.rst:edit :file:doc/users/project/citing.rst. Commit the new SVG, the change to
doc/devel/release_guide.rst::file:tools/cache_zenodo_svg.py, and the changes to :file:doc/users/project/citing.rst
doc/index.rst: users/project/index.rst
doc/users/project/credits.rst:Please also see our instructions on :doc:/users/project/citing.
- use the ref instead
tools/cache_zenodo_svg.py: citing = doc_dir / "users/project/citing.rst"

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

https://github.com/matplotlib/matplotlib/tree/main/doc

story645 · 2024-01-10T17:33:01Z

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:

https://github.com/search?q=repo%3Amatplotlib%2Fmpl-brochure-site%20users%2Fproject&type=code

shriyakalakata · 2024-01-10T18:44:53Z

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 · 2024-01-10T19:20:46Z

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:

https://github.com/search?q=repo%3Amatplotlib%2Fmpl-brochure-site%20users%2Fproject&type=code

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 · 2024-01-10T19:53:35Z

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

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 · 2024-01-11T07:19:18Z

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 · 2024-01-11T09:27:57Z

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 · 2024-01-17T20:23:29Z

@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

story645

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?

github-actions bot added the status: needs rebase label Dec 23, 2023

shriyakalakata force-pushed the user_guide_docs branch from d9bb8ba to 509c296 Compare January 10, 2024 16:31

github-actions bot removed the status: needs rebase label Jan 10, 2024

story645 added the Documentation label Jan 10, 2024

story645 added this to the v3.9.0 milestone Jan 10, 2024

story645 mentioned this pull request Jan 10, 2024

DOC: update doc/readme.txt & remove devel/readme #27631

Merged

shriyakalakata marked this pull request as draft January 10, 2024 18:31

story645 requested changes Jan 10, 2024

View reviewed changes

shriyakalakata mentioned this pull request Jan 11, 2024

Updated links to change 'users/project/' to 'project/' matplotlib/mpl-brochure-site#90

Merged

shriyakalakata added 10 commits January 26, 2024 15:31

Moved /users/project to /doc/project

d1e23ee

Updated license paths

b1e81eb

Editing folder structure info for doc/project/

5e04140

Editing folder structure info

e1b418d

Updated folder structure in pre-commit file

821d512

Refactored references from users/project/ to project/ in affected files

25567d9

Update CITATION.bib file path

de170eb

Update relative path to ../_static

d7ba93f

Update relative path to ../_static

45b6cfa

Update output of tools/cache_zenodo_svg.py

4e7956b

shriyakalakata force-pushed the user_guide_docs branch from b1def60 to 4e7956b Compare January 26, 2024 20:34

github-actions bot added the Documentation: devdocs files in doc/devel label Jan 26, 2024

shriyakalakata marked this pull request as ready for review January 29, 2024 22:09

story645 mentioned this pull request Jan 29, 2024

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

Open

10 tasks

story645 approved these changes Jan 29, 2024

View reviewed changes

QuLogic merged commit 968e554 into matplotlib:main Feb 2, 2024

story645 mentioned this pull request Feb 4, 2024

[Doc]: Citation link in the readme.md points to 404 #27746

Closed

story645 mentioned this pull request Feb 29, 2024

[Doc]: code-of-conduct URL in git repository may be outdated #27834

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

shriyakalakata commented Dec 23, 2023

Uh oh!

story645 commented Dec 24, 2023

Uh oh!

story645 commented Jan 10, 2024

Uh oh!

story645 commented Jan 10, 2024 •

edited

Loading

Uh oh!

story645 commented Jan 10, 2024

Uh oh!

shriyakalakata commented Jan 10, 2024

Uh oh!

shriyakalakata commented Jan 10, 2024

Uh oh!

story645 commented Jan 10, 2024 •

edited

Loading

Uh oh!

story645 left a comment •

edited

Loading

Uh oh!

shriyakalakata commented Jan 11, 2024

Uh oh!

QuLogic commented Jan 11, 2024

Uh oh!

story645 commented Jan 17, 2024

Uh oh!

story645 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

shriyakalakata commented Dec 23, 2023

PR summary

PR checklist

Uh oh!

story645 commented Dec 24, 2023

Uh oh!

story645 commented Jan 10, 2024

Uh oh!

story645 commented Jan 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

story645 commented Jan 10, 2024

Uh oh!

shriyakalakata commented Jan 10, 2024

Uh oh!

shriyakalakata commented Jan 10, 2024

Uh oh!

story645 commented Jan 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

story645 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shriyakalakata commented Jan 11, 2024

Uh oh!

QuLogic commented Jan 11, 2024

Uh oh!

story645 commented Jan 17, 2024

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

story645 commented Jan 10, 2024 •

edited

Loading

story645 commented Jan 10, 2024 •

edited

Loading

story645 left a comment •

edited

Loading