Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
dstansby merged 2 commits intomatplotlib:masterfromtimhoffm:getting-started
Oct 9, 2021

Conversation

timhoffm
Copy link
Member

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

tacaswell reacted with hooray emoji
@jklymak
Copy link
Member

This seems OK, however, I think it significantly overlapsdoc/index.html both conceptually and in content. Can we just add the example todoc/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
MemberAuthor

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 whereasindex 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 fromindex 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 ingetting_started).

story645 reacted with thumbs up emoji

@jklymak
Copy link
Member

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

@jklymak
Copy link
Member

@jklymakjklymak requested a review fromstory645October 8, 2021 14:34
@timhoffm
Copy link
MemberAuthor

Sure.

@jklymak
Copy link
Member

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

@dstansbydstansby merged commit3557392 intomatplotlib:masterOct 9, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestOct 9, 2021
@timhoffmtimhoffm deleted the getting-started branchOctober 9, 2021 21:56
timhoffm added a commit that referenced this pull requestOct 9, 2021
…313-on-v3.5.xBackport PR#21313 on branch v3.5.x (DOC: Minimal getting started page)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull requestOct 12, 2021
tacaswell pushed a commit that referenced this pull requestOct 20, 2021
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@story645story645story645 approved these changes

@dstansbydstansbydstansby approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

4 participants
@timhoffm@jklymak@story645@dstansby

[8]ページ先頭

©2009-2025 Movatter.jp