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

doc: Misc fixes to "Report an issue" in the documentation functionality. #64788

Merged
merged 7 commits into from
Nov 9, 2023

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Nov 3, 2023

📄 https://builds.zephyrproject.io/zephyr/pr/64788/docs/

Usability:

  • Rename the label to "Report an issue with this page"
  • Use MAINTAINERS file to auto-populate all relevant labels when creating the issue (and not just "area: Documentation" like it does currently), to simplify triaging and get zephyrbot to do more work for us.

Bug fixes:

  • Samples and boards were missing Github links due to a regression introduced in a previous commit

See commits for more details.

Add documentation to the get_page_prefix method.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
@kartben kartben changed the title doc: Misc fixes to "Report an issue for this page" functionality. doc: Misc fixes to "Report an issue" in the documentation functionality. Nov 3, 2023
@kartben kartben marked this pull request as ready for review November 3, 2023 15:56
doc/_extensions/zephyr/gh_utils.py Show resolved Hide resolved
doc/_extensions/zephyr/gh_utils.py Outdated Show resolved Hide resolved
doc/_extensions/zephyr/gh_utils.py Show resolved Hide resolved
doc/_extensions/zephyr/gh_utils.py Show resolved Hide resolved
Compute ZEPHYR_BASE like other extensions do rather than artificially
pretend it's a config option.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Use BuildEnvironment to get the path of a document.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Page prefix can be an empty string.
Fixed the condition so that it only evaluates to try when prefix is
truly None.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Not sure why I used square brackets for "[doc]" prefix of the default
Github issue title. Change it to "doc:".

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Use get_maintainer.py to add more meaningful labels to issues creates
from a documentation page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Clarify the "Report an issue" label in HTML documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
@carlescufi carlescufi merged commit 7d3381f into zephyrproject-rtos:main Nov 9, 2023
14 checks passed
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.

7 participants