Skip to content

DOC: Minimal getting started page #21313

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

Merged
merged 2 commits into from
Oct 9, 2021
Merged

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Oct 7, 2021

PR Summary

This is intended to be the target page for the Front page icon "Getting started".

TOC position will depend on the final shape of #21251. For now, I've put it in the old structure. I don't mind which one gets merged first and which one will have to rebase.

This is very basic but much better than pointing "Getting started" to the table of contents. People are welcome to refine if they have improvements (may also be a direct push).

@jklymak
Copy link
Member

jklymak commented Oct 8, 2021

This seems OK, however, I think it significantly overlaps doc/index.html both conceptually and in content. Can we just add the example to doc/index.html and think of the front pages of the docs as the place where users "get started"?

Co-authored-by: hannah <story645@gmail.com>
@timhoffm
Copy link
Member Author

timhoffm commented Oct 8, 2021

Can we [...] think of the front pages of the docs as the place where users "get started"?

From an audience point of view, getting_started addresses new users whereas index addresses all users. So the first is more specific and a subset of the second. If we integrate all new-user-relevant information on the main page, we have to make sure not to clutter it too much and by that reduce usability for other users. E.g. the example takes a lot of space but is irrelevant for all people who have used Matplotlib before. It could also well be that we want to add some more information target at new users. I've just created a very basic set, which may or may not be all we want to say to new users. Therefore I'm inclinded to keep the pages separate and focussed on the respective audinence even if that means some duplication.

I agree however, that there could be more refinement. I'd be open to remove the installation part from index and replace it with getting started. Installation in itself is not very valuable. Existing users don't need it. New users probably need more information to get productive (exactly what we want to write in getting_started).

@jklymak
Copy link
Member

jklymak commented Oct 8, 2021

I'm fine with that too. If we do this, can I suggest we make this doc/users/getting_started/index.html? and then we could add other "beginner" resources here?

@jklymak jklymak requested a review from story645 October 8, 2021 14:34
@timhoffm
Copy link
Member Author

timhoffm commented Oct 8, 2021

Sure.

@jklymak
Copy link
Member

jklymak commented Oct 8, 2021

Well we can do it in the rebase of the reorg. But @story645 is blocking 😀

@dstansby dstansby merged commit 3557392 into matplotlib:master Oct 9, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 9, 2021
@timhoffm timhoffm deleted the getting-started branch October 9, 2021 21:56
timhoffm added a commit that referenced this pull request Oct 9, 2021
…313-on-v3.5.x

Backport PR #21313 on branch v3.5.x (DOC: Minimal getting started page)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
DOC: Minimal getting started page
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.

4 participants