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 #430

Closed
VachaShah opened this issue Apr 25, 2022 · 2 comments
Closed

Add a workflow for documenting features #430

VachaShah opened this issue Apr 25, 2022 · 2 comments
Assignees
Labels
ci enhancement New feature or request

Comments

@VachaShah
Copy link
Contributor

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.

@qreshi
Copy link
Contributor

qreshi commented Aug 2, 2022

Hey @VachaShah, we've added the GitHub Action for this issue. Do you need to do any configuration for the app_id or secret_key like what was done for the backport workflow or is that a one time thing? If not, I can close this issue out.

@VachaShah
Copy link
Contributor Author

Hi @qreshi, nope its a one time thing, you can close this issue.

@qreshi qreshi closed this as completed Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants