Title: [Doc]: Move non user guide related content out of `/users` · Issue #27396 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Move non user guide related content out of `/users` · Issue #27396 · matplotlib/matplotlib
X Title: [Doc]: Move non user guide related content out of `/users` · Issue #27396 · matplotlib/matplotlib
Description: Problem Given that /doc is now the root folder/index, a lot of the indexing that used to live on the users index page is now on the doc/index and it's a little easier to find things when the code structure matches the indexing. Also curr...
Open Graph Description: Problem Given that /doc is now the root folder/index, a lot of the indexing that used to live on the users index page is now on the doc/index and it's a little easier to find things when the code s...
X Description: Problem Given that /doc is now the root folder/index, a lot of the indexing that used to live on the users index page is now on the doc/index and it's a little easier to find things when the co...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/27396
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Move non user guide related content out of `/users`","articleBody":"### Problem\n\nGiven that `/doc` is now the root folder/index, a lot of the indexing that used to live on the `users` index page is now on the `doc/index` and it's a little easier to find things when the code structure matches the indexing. Also currently it's a little hard to define what we mean by user guide and scoping the contents of the folder can help in defining the purpose. \n\n### Suggested improvement\n\n- [x] `/users/project` -\u003e `/doc/project` \n- [x] `/users/installing`-\u003e`doc/installing` \n- [x] `/users/{generate_credits, github_stats, *_whats_new, release_notes*}` -\u003e `/doc/release`\n- [ ] `/getting_started/* -\u003e quickstart guide\n- [ ] `/users/users_explain/*` -\u003e `/users`\n\n#### Consensus\n\nAs discussed on the call, the rough consensus is this organization makes sense but should be done in stages, roughly one folder at a time. Largest concern was getting all the [redirects](https://matplotlib.org/devdocs/devel/document.html#move-documentation) correct and making sure that any links and instructions related to those docs are updated as needed. The stages are:\n\n- [x] move the `/project` folder up -\u003ehttps://github.com/matplotlib/matplotlib/pull/27560\n- [x] move the `/installing` folder up -\u003e (might be a good chance to change the name to install?) https://github.com/matplotlib/matplotlib/pull/27747\n- [x] move the release related folders and docs {generate_credits, github_stats, *_whats_new, release_notes*} into a folder and up one level\n- [ ] merge the contents in `users/getting_started` into the `gallery/users_explain/quickstart guide` and remove the `getting_started` folder\n- [ ] remove `doc/users` and rename `gallery/users_explain` to users \n\n#### Motivation\n\n* currently `/users/index/` is scoped to `users_explain` + `getting_started`, this would be matching structure to stated structure, in turn making it easier to find where a doc is to change it\n * also means we can remove the symlink, which currently trips folks up when trying to edit documents under /user \n* the contents under `/project` are I think version independent (though we may want to keep the versioning on the site b/c the historicity is also important) but also for the most part should not be changed w/o consensus/streering-council sign off and it's a little easier to communicate that if it's not lumped with other user docs\n* I'm half/half on `/doc/install` b/c I understand why it would be inside a users guide but we also write those documents as a more general installation guide/reference for both \n* there are a lot of files related to the release process and unlike `/api/changes` it's not clear why they are here. \n","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2023-11-29T20:22:59.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/27396/matplotlib/issues/27396"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:cbef3b2a-07e8-71ba-d3cf-50c91953342b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B0CA:362D3E:55D6A9:7332BA:6A527EBC |
| html-safe-nonce | 0c9e1244d84fc258d59a0857c06461b4115c7ae06cc63af02e42e6284b7a476a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMENBOjM2MkQzRTo1NUQ2QTk6NzMzMkJBOjZBNTI3RUJDIiwidmlzaXRvcl9pZCI6IjU4OTk2MDY1NzE3OTM2NzgwMTIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 191a3ef11fde56796b7284aff5ee67581712f861469d916041b416f0f1e8b902 |
| hovercard-subject-tag | issue:2017357629 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/27396/issue_layout |
| twitter:image | https://opengraph.githubassets.com/355cc689fc4e866a7e4a4c5da468a0bb2e7acedc5a3157beab863589e7e56ef4/matplotlib/matplotlib/issues/27396 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/355cc689fc4e866a7e4a4c5da468a0bb2e7acedc5a3157beab863589e7e56ef4/matplotlib/matplotlib/issues/27396 |
| og:image:alt | Problem Given that /doc is now the root folder/index, a lot of the indexing that used to live on the users index page is now on the doc/index and it's a little easier to find things when the code s... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | story645 |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width