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

Expand UX documentation to include 2020 research #10745

Merged
merged 34 commits into from
Apr 14, 2024
Merged

Conversation

nlhkabu
Copy link
Member

@nlhkabu nlhkabu commented Dec 23, 2021

Preview
https://pip--10745.org.readthedocs.build/en/10745/ux-research-design/

TODO

  • Cleanup markdown
  • Ensure all links are working and point to the right place
  • Make sure images and working, including alt-text

@nlhkabu nlhkabu mentioned this pull request Dec 23, 2021
3 tasks
@brainwane
Copy link
Contributor

@ei8fdb it would be wonderful if you could also add in the UX training materials from the trainings you led at the end of 2020 and the start of 2021. Thank you!

@brainwane
Copy link
Contributor

By the way, I'm about to link to this in a blog post since it's (I think) the only place this valuable information is. Looking forward to the merge!

@nlhkabu
Copy link
Member Author

nlhkabu commented Aug 20, 2023

@brainwane you've motivated me to get this merged!

Do you have much experience with RST? It's driving me a bit nuts - I have this TOC

```{toctree}
about-our-users
ci-cd
improving-pip-documentation
mental-models
override-conflicting-dependencies
personas
pip-force-reinstall
pip-logo
pip-search
pip-upgrade-conflict
prioritizing-features
users-and-security
```

But it's not producing the links in the menu:

Screenshot 2023-08-20 at 10-06-54 UX Research Results - pip documentation v22 0 dev0

any ideas what I am doing wrong here? Otherwise @pradyunsg are you able to point me in the right direction?

@pradyunsg
Copy link
Member

pradyunsg commented Aug 20, 2023

The toctree needs to be at the "top level" of the document -- i.e. in the first heading or before it. That might be implicated in the behaviour you're seeing?

@brainwane
Copy link
Contributor

[I posted "User Support, Equanimity, And Potential Cross-Project Tools and Practices in Open Source" and linked to the Read the Docs build of this PR in the section "Shared user experience research efforts".]

@konstin
Copy link
Contributor

konstin commented Oct 12, 2023

Is there still interest in merging this? There's so much important research in here that would otherwise be lost. I read through all the pages on the docs preview and at least in that they looked ready to me

@jvns
Copy link

jvns commented Apr 12, 2024

I noticed that all of the "write up" links in the surveys section here are 404s, I would love to read those!

@nlhkabu nlhkabu force-pushed the add-ux-docs branch 2 times, most recently from 1fe1b71 to 33e1f9d Compare April 13, 2024 20:49
@nlhkabu nlhkabu marked this pull request as ready for review April 14, 2024 12:46
@nlhkabu
Copy link
Member Author

nlhkabu commented Apr 14, 2024

Just 2.5 years later... this PR is now ready to merge.

Thanks @konstin and @jvns for the motivation to clean this up - I hope you find the content valuable.

@pradyunsg the commit history on this PR is a complete mess - if you wouldn't mind squashing the commits when you merge into main, that would be much appreciated.

@nlhkabu nlhkabu changed the title scaffold UX docs Expand UX documentation to include 2020 research Apr 14, 2024
Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

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

Just a couple of minor points. I haven't reviewed the main part of the docs, but +1 on getting this landed. It's easy enough to do follow up PRs if changes are needed.

- Understand pip’s strengths and shortcomings
- Make useful design recommendations for improving pip

If you are interested in participating in pip user research, please [join pip’s user panel](https://mail.python.org/mailman3/lists/pip-ux-studies.python.org/).
Copy link
Member

Choose a reason for hiding this comment

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

Is the mailing list still active? I notice that the link on that page for more information is broken.

Copy link
Member

Choose a reason for hiding this comment

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

It is. I'll fix the link on the mailing list description. :)

docs/html/ux-research-design/contribute.md Outdated Show resolved Hide resolved
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
@pradyunsg pradyunsg merged commit 5da6b2f into pypa:main Apr 14, 2024
7 of 8 checks passed
@nlhkabu nlhkabu deleted the add-ux-docs branch April 14, 2024 14:03
@nlhkabu
Copy link
Member Author

nlhkabu commented Apr 14, 2024

Hoorah! 🕺 Thank you both for the quick review. I am very happy to have this merged :)

@brainwane
Copy link
Contributor

Thank you @nlhkabu @pradyunsg @pfmoore for your work getting this finished and merged! It's such valuable knowledge, not just to pip, and not just to Python packaging, but also as a model for other developer tools, command-line tools, and open source projects more widely. I'm so glad to be able to more easily share this work!

cc @ei8fdb @georgiamoon [blast from the past!]

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants