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

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

Add a workflow for documenting features #1493

VachaShah opened this issue Apr 25, 2022 · 1 comment · Fixed by #1515
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 ci labels Apr 25, 2022
@kavilla
Copy link
Member

kavilla commented Apr 25, 2022

Oh nice I love it!

kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Apr 28, 2022
Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Apr 28, 2022
Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

update doc

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Apr 28, 2022
Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
@kavilla kavilla linked a pull request Apr 28, 2022 that will close this issue
7 tasks
ashwin-pc pushed a commit that referenced this issue Apr 29, 2022
* [CI] Create doc issue workflow

Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

* follow up

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
pjfitzgibbons pushed a commit to pjfitzgibbons/OpenSearch-Dashboards that referenced this issue Aug 10, 2022
* [CI] Create doc issue workflow

Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

* follow up

Signed-off-by: Kawika Avilla <kavilla414@gmail.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