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

Consider linking to open and closed issues from package documentation #13484

Open
danielbachhuber opened this issue Jan 24, 2019 · 3 comments
Open
Labels
[Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Comments

@danielbachhuber
Copy link
Member

One feature of the WP-CLI documentation is that we include links to "Open Issues", "Closed Issues", and "Create New Issue":

image

From https://developer.wordpress.org/cli/commands/site/empty/

The theory behind this feature is that, if the user doesn't find an answer to their question in the documentation, they can:

  • See if someone has already opened an issue on the same topic.
  • Review closed issues to see if the answer might be there.
  • Open a new issue if their question isn't covered elsewhere.

Would this be worthwhile to include in the block editor documentation? The most important configuration aspect is that we need to be able to map individual documents to their corresponding GitHub label.

Here's the corresponding code in devhub: https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php#L305

@danielbachhuber danielbachhuber added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers labels Jan 24, 2019
@youknowriad youknowriad removed this from the Documentation & Handbook milestone Mar 18, 2019
@paaljoachim
Copy link
Contributor

Hey Daniel @danielbachhuber

Thank you for creating this issue!
I believe that @noisysocks Robert and Marcus @mkaz would have some view points on this issue.

@noisysocks
Copy link
Member

Not against it if somebody wants to implement this. What do you think @annezazu?

@annezazu
Copy link
Contributor

annezazu commented Feb 5, 2021

Ohhh I think this is a great idea! I also like that it helps direct people here. Especially now that the issues templates are re-done, I think it'll help prevent to many general help requests too that tend to be out of scope.

@mtias mtias added the [Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later label Jul 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

6 participants