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

Add a workflow for documenting features #300

Open
VachaShah opened this issue Apr 25, 2022 · 1 comment
Open

Add a workflow for documenting features #300

VachaShah opened this issue Apr 25, 2022 · 1 comment
Labels
ci documentation Improvements or additions to documentation enhancement New feature or request

Comments

@VachaShah
Copy link

Is your feature request related to a problem?
Humans have to remember to document features, or at least to open issues in documentation-website for new features/changes to be documented. This is a manual process, e.g. opensearch-project/OpenSearch#1711 (comment)

What solution would you like?
Add a workflow for creating issues in the documentation-website repo whenever a label needs-documentation is added on a PR. Refer: opensearch-project/OpenSearch#2929

What alternatives have you considered?
Create issues manually in the documentation-website whenever a feature needs to be documented.

Do you have any additional context?
Add any other context or screenshots about the feature request here.

@ylwu-amzn
Copy link
Collaborator

What we should do for this issue? Should we track the discussion on the meta issue opensearch-project/project-meta#43?

@sean-zheng-amazon sean-zheng-amazon added documentation Improvements or additions to documentation and removed untriaged labels Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants