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

Closed
VachaShah opened this issue Apr 25, 2022 · 1 comment · Fixed by #1373
Closed

Add a workflow for documenting features #1326

VachaShah opened this issue Apr 25, 2022 · 1 comment · Fixed by #1373
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.

@VachaShah VachaShah added enhancement New feature or request untriaged ci labels Apr 25, 2022
cmanning09 added a commit to cmanning09/data-prepper that referenced this issue May 2, 2022
resolves opensearch-project#1326

Signed-off-by: Christopher Manning <cmanning09@users.noreply.github.com>
@cmanning09
Copy link
Contributor

Thanks @VachaShah, this seems like a nice feature to help track documentation for releases.

cmanning09 added a commit that referenced this issue May 3, 2022
resolves #1326

Signed-off-by: Christopher Manning <cmanning09@users.noreply.github.com>
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

Successfully merging a pull request may close this issue.

2 participants