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

Explore integrating GitHub issues into documentation #940

Closed
jpmckinney opened this issue Nov 19, 2019 · 1 comment
Closed

Explore integrating GitHub issues into documentation #940

jpmckinney opened this issue Nov 19, 2019 · 1 comment
Assignees
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues wontfix issues that are closed without resolution

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Nov 19, 2019

We might tag issues with specific labels, that can then be rendered in the documentation. The simple implementation of this depends on being able to use the GitHub API on the client side. A more complex implementation would involve creating a middleware API that serves up issues by label, for the documentation to render.

For example, #322 #438 #872

Suggested by @yolile

@jpmckinney jpmckinney added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label Nov 19, 2019
@jpmckinney jpmckinney added this to the 1.1.5 milestone Jan 13, 2020
@jpmckinney jpmckinney self-assigned this Mar 16, 2020
@jpmckinney
Copy link
Member Author

I think the only robust way to do this is to manually add links to issues in the documentation (as we've started to do in several worked examples). Otherwise, we'll have to support a very large number of labels, in order to allow the issue links to appear everywhere relevant in the docs, which will be a very complicated system to use.

@jpmckinney jpmckinney removed this from the Iterative improvements milestone Jun 9, 2020
@jpmckinney jpmckinney added the wontfix issues that are closed without resolution label Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues wontfix issues that are closed without resolution
Projects
None yet
Development

No branches or pull requests

1 participant