diff options
author | Nicole Harris <n.harris@kabucreative.com> | 2021-07-18 20:55:42 +0100 |
---|---|---|
committer | Nicole Harris <n.harris@kabucreative.com> | 2021-07-18 20:55:42 +0100 |
commit | a7b4cfc62e289a6ce8061989574c25a3c224a5a0 (patch) | |
tree | 53826d08e2e480bdc735dab8d0020d4aed071b56 | |
parent | 5be19ac16f058c5750bc7ea47c29d6382491fedb (diff) | |
download | pip-a7b4cfc62e289a6ce8061989574c25a3c224a5a0.tar.gz |
Fix links in UX docs, improve headings
-rw-r--r-- | docs/html/ux-research-design/contribute.md | 14 | ||||
-rw-r--r-- | docs/html/ux-research-design/guidance.md | 2 | ||||
-rw-r--r-- | docs/html/ux-research-design/index.md | 6 | ||||
-rw-r--r-- | docs/html/ux-research-design/research-results.md | 2 |
4 files changed, 9 insertions, 15 deletions
diff --git a/docs/html/ux-research-design/contribute.md b/docs/html/ux-research-design/contribute.md index 862dc5c36..420dc73a7 100644 --- a/docs/html/ux-research-design/contribute.md +++ b/docs/html/ux-research-design/contribute.md @@ -19,14 +19,8 @@ You can help the team by testing new features as they are released to the commun If you believe that you have found a user experience bug in pip, or you have ideas for how pip could be made better for all users, please file an issue on the[ pip issue tracker](https://github.com/pypa/pip/issues/new). -You can also help improve pip’s user experience by[ working on UX issues](https://github.com/pypa/pip/issues?q=is%3Aissue+is%3Aopen+label%3A%22K%3A+UX%22). Issues that are ideal for new contributors are marked with “[good first issue](https://github.com/pypa/pip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)”. Explore the +You can also help improve pip’s user experience by [working on UX issues](https://github.com/pypa/pip/issues?q=is%3Aissue+is%3Aopen+label%3A%22K%3A+UX%22). Issues that are ideal for new contributors are marked with “[good first issue](https://github.com/pypa/pip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)”. Explore the +[UX Guidance](guidance) in the docs if you have questions. -<p id="gdcalert4" ><span style="color: red; font-weight: bold">>>>>> gd2md-html alert: undefined internal link (link text: "UX Guidance"). Did you generate a TOC? </span><br>(<a href="#">Back to top</a>)(<a href="#gdcalert5">Next alert</a>)<br><span style="color: red; font-weight: bold">>>>>> </span></p> - -[UX Guidance](#heading=h.jo9qbv2k55nx) in the docs if you have questions. - -Currently, we are also looking for volunteers to move UX recommendations (see “ - -<p id="gdcalert5" ><span style="color: red; font-weight: bold">>>>>> gd2md-html alert: undefined internal link (link text: "results of user research"). Did you generate a TOC? </span><br>(<a href="#">Back to top</a>)(<a href="#gdcalert6">Next alert</a>)<br><span style="color: red; font-weight: bold">>>>>> </span></p> - -[results of user research](#heading=h.nytdt34uvs56)”) into the issue tracker - either by opening new issues, or by commenting on relevant existing issues. +Currently, we are also looking for volunteers to move UX recommendations (see +[results of user research](research-results)) into the issue tracker - either by opening new issues, or by commenting on relevant existing issues. diff --git a/docs/html/ux-research-design/guidance.md b/docs/html/ux-research-design/guidance.md index 060f81cf4..d7e20c434 100644 --- a/docs/html/ux-research-design/guidance.md +++ b/docs/html/ux-research-design/guidance.md @@ -1,4 +1,4 @@ -# Pip UX research and design guidelines +# UX guidelines This section of the documentation is intended for contributors who wish to work on improving pip's user experience, including pip's documentation. diff --git a/docs/html/ux-research-design/index.md b/docs/html/ux-research-design/index.md index fd1fa4011..9338cd684 100644 --- a/docs/html/ux-research-design/index.md +++ b/docs/html/ux-research-design/index.md @@ -11,6 +11,6 @@ research-results Welcome to pip’s UX research and design documentation. The purpose of this section of the documentation is to: -- [Identify where new contributors can participate in or lead UX research and design activities](ux-research-design/contribute) -- [Share pip UX research and design guidelines](ux-research-design/guidance), including an introduction to User Centered Design practices, and how they can be applied to the pip project -- Share [results of user research](ux-research-design/research-results) that the pip team has already conducted +- [Identify where new contributors can participate in or lead UX research and design activities](contribute) +- [Share pip UX guidelines](guidance), including an introduction to User Centered Design practices, and how they can be applied to the pip project +- Share [results of user research](research-results) that the pip team has already conducted diff --git a/docs/html/ux-research-design/research-results.md b/docs/html/ux-research-design/research-results.md index d7499f856..9cdb395ef 100644 --- a/docs/html/ux-research-design/research-results.md +++ b/docs/html/ux-research-design/research-results.md @@ -51,7 +51,7 @@ During the interviews, we asked users about: - What other technical documentation they value, and how the pip docs could take inspiration from these - What other resources the pip team could provide to help pip users solve their problems -####<a name="survey-results"></a>Surveys +#### <a name="survey-results"></a>Surveys We **published 10 surveys** to gather feedback about pip's users and their preferences: |