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

Update quickstart guide to reflect user research #9137

Closed
wants to merge 5 commits into from
Closed

Conversation

nlhkabu
Copy link
Member

@nlhkabu nlhkabu commented Nov 15, 2020

Updates quickstart guide to reflect most common tasks as discovered in our "buy a feature" user research.

Preview: https://pip--9137.org.readthedocs.build/en/9137/quickstart/

docs/html/quickstart.rst Outdated Show resolved Hide resolved
docs/html/quickstart.rst Outdated Show resolved Hide resolved
docs/html/quickstart.rst Outdated Show resolved Hide resolved
@nlhkabu
Copy link
Member Author

nlhkabu commented Nov 17, 2020

@pradyunsg or @uranusjr this content is ready for review.
If you can let me know if it is accurate I will fix linting and add a news entry. Thanks!

Copy link
Member

@pradyunsg pradyunsg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me! A few fairly minor comments.

docs/html/quickstart.rst Show resolved Hide resolved
docs/html/quickstart.rst Show resolved Hide resolved
docs/html/quickstart.rst Show resolved Hide resolved
@uranusjr
Copy link
Member

#9131 (merged recently) also included similar instruction on installing and upgrading pip in the Installaton page. Is this duplication intentional, or should we simply redirect users to that page instead?

Current “latest” pip documentation: https://pip.pypa.io/en/latest/installing/

@pradyunsg
Copy link
Member

@nlhkabu If you rebase this PR on the current master branch, that'll fix the CI here.

Is this duplication intentional, or should we simply redirect users to that page instead?

https://www.writethedocs.org/guide/writing/docs-principles/#arid

I think this duplication is A-OK.

@nlhkabu nlhkabu deleted the docs-quickstart branch July 5, 2021 20:09
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants