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

Making it easier for our users to report documentation issues or questions #522

Merged
merged 4 commits into from
Nov 5, 2024

Conversation

kaushikvelusamy
Copy link
Contributor

This pointer on the left pane will speedup the process to find documentation issues / questions and help resolve documentation faster by quickly assigning the relevant docs section owner.

docs/issues.md Outdated Show resolved Hide resolved
docs/issues.md Outdated Show resolved Hide resolved
kaushikvelusamy and others added 2 commits November 5, 2024 12:59
Co-authored-by: Kyle Gerard Felker <felker@anl.gov>
Co-authored-by: Kyle Gerard Felker <felker@anl.gov>
Copy link
Contributor Author

@kaushikvelusamy kaushikvelusamy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepted all suggestions.

Copy link
Member

@felker felker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but have others already weighed in on this change? I think it is a good idea, generally, but maybe we would rather put it on the home page like NERSC does?

image

https://docs.nersc.gov/

@kaushikvelusamy
Copy link
Contributor Author

I think we should have a pointer to this on every documentation page making it structurally easier for users to quickly raise issues and contribute faster.

We should also add a guideline preamble on the new issue page to triage and delegate it to the right person faster . Example: https://github.com/pytorch/pytorch/issues/new?assignees=&labels=&projects=&template=documentation.yml

@kaushikvelusamy kaushikvelusamy merged commit 15697ac into argonne-lcf:main Nov 5, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants