The Wayback Machine - https://web.archive.org/web/20240106173901/https://github.com/matplotlib/matplotlib/issues/27396
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

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

Open
5 tasks
story645 opened this issue Nov 29, 2023 · 1 comment · May be fixed by #27560
Open
5 tasks

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

story645 opened this issue Nov 29, 2023 · 1 comment · May be fixed by #27560
Assignees
Labels
Documentation: website layout/behavior/styling changes Documentation

Comments

@story645
Copy link
Member

story645 commented Nov 29, 2023

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 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.

Suggested improvement

  • /users/project -> /doc/project
  • /users/installing->doc/installing
  • /users/{generate_credits, github_stats, *_whats_new, release_notes*} -> /doc/release
  • `/getting_started/* -> quickstart guide
  • /users/users_explain/* -> /users

Consensus

As 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 correct and making sure that any links and instructions related to those docs are updated as needed. The stages are:

  • move the /project folder up ->
  • move the /installing folder up -> (might be a good chance to change the name to install?)
  • move the release related folders and docs {generate_credits, github_stats, _whats_new, release_notes} into a folder and up one level
  • merge the contents in users/getting_started into the gallery/users_explain/quickstart guide and remove the getting_started folder
  • remove doc/users and rename gallery/users_explain to users

Motivation

  • 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
    • also means we can remove the symlink, which currently trips folks up when trying to edit documents under /user
  • 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
  • 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
  • there are a lot of files related to the release process and unlike /api/changes it's not clear why they are here.
@story645 story645 added Documentation Documentation: website layout/behavior/styling changes labels Nov 29, 2023
@story645 story645 added the status: needs comment/discussion needs consensus on next step label Dec 9, 2023
@story645 story645 self-assigned this Dec 13, 2023
@story645 story645 removed the status: needs comment/discussion needs consensus on next step label Dec 15, 2023
@shriyakalakata
Copy link
Contributor

@story645 I can start working on this now!

@shriyakalakata shriyakalakata linked a pull request Dec 23, 2023 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: website layout/behavior/styling changes Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants