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

Make difference between content and engineering issues clearer in issue template chooser #7570

Closed
Simran-B opened this issue Jun 22, 2021 · 2 comments · Fixed by #7938
Closed
Assignees
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs triage Do not begin working on this issue until triaged by the team

Comments

@Simran-B
Copy link
Contributor

What article on docs.github.com is affected?

https://github.com/github/docs/tree/main/.github/ISSUE_TEMPLATE

What part(s) of the article would you like to see updated?

I find the first two options in the issue template chooser quite confusing:

image

It's not clear what the difference is, especially because all the content is on the docs.github.com site. The intention becomes clear if you look at the labels:

  • Improve existing docs -> content
  • Improve the docs.github.com site -> engineering

I suggest changing the titles and descriptions to reflect that one is for content issues and one for technical issues (Markdown rendering etc.).

@Simran-B Simran-B added the content This issue or pull request belongs to the Docs Content team label Jun 22, 2021
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 22, 2021
Zheka11 referenced this issue Jun 22, 2021
Co-authored-by: chiedo <chiedo@users.noreply.github.com>
@janiceilene
Copy link
Contributor

You're definitely right @Simran-B! Do you think the word "content" would be less confusing for folks? So maybe:

Improve existing content
Make a suggestion to improve the content in an existing article

Improve the docs.github.com site
Make a suggestion to improve the technical implementation on docs.github.com

What do you think?

@janiceilene janiceilene added the contributing docs Content related to our contributing docs label Jun 22, 2021
@Simran-B
Copy link
Contributor Author

My gut feeling is that it should say

technical implementation of docs.github.com

but I really like your suggestion!

@ramyaparimi ramyaparimi self-assigned this Jul 6, 2021
janiceilene added a commit that referenced this issue Jul 6, 2021
Reword "name" and "about" issue template frontmatter (#7570)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs triage Do not begin working on this issue until triaged by the team
Projects
None yet
5 participants
@Simran-B @janiceilene @ramyaparimi and others