[PROPOSAL] Create a workflow for documenting features

[dblock]

What kind of business use case are you trying to solve? What are your requirements?

Humans have to remember to document features, or at least to open issues in documentation-website for new features/changes to be documented.

What is the problem? What is preventing you from meeting the requirements?
This is a manual process, e.g. opensearch-project/OpenSearch#1711 (comment)

What are you proposing? What do you suggest we do to solve the problem or improve the existing situation?
Create a workflow that opens issues in documentation-website when a label "needs-documentation" is added, like for backport PRs.

• geospatial - Add a workflow for documenting features geospatial#52
• sql - Add a workflow for documenting features sql#590
• OpenSearch-Dashboards - Add a workflow for documenting features OpenSearch-Dashboards#1493
• notifications - Add a workflow for documenting features notifications#430
• index-management-dashboards-plugin - Add a workflow for documenting features index-management-dashboards-plugin#188
• anomaly-detection - Add a workflow for documenting features anomaly-detection#520
• security-dashboards-plugin - Add a workflow for documenting features security-dashboards-plugin#967
• performance-analyzer - Add a workflow for documenting features performance-analyzer#195
• security - Add a workflow for documenting features security#1786
• data-prepper - Add a workflow for documenting features data-prepper#1326
• k-NN - Add a workflow for documenting features k-NN#374
• helm-charts - Add a workflow for documenting features helm-charts#252
• cross-cluster-replication - Add a workflow for documenting features cross-cluster-replication#381
• alerting - Add a workflow for documenting features alerting#425
• ml-commons - Add a workflow for documenting features ml-commons#300
• alerting-dashboards-plugin - Add a workflow for documenting features alerting-dashboards-plugin#225
• index-management - Add a workflow for documenting features index-management#346
• observability - Add a workflow for documenting features dashboards-observability#122
• dashboards-reports - Add a workflow for documenting features reporting#349
• dashboards-visualizations - Add a workflow for documenting features dashboards-visualizations#76
• asynchronous-search - Add a workflow for documenting features asynchronous-search#139
• job-scheduler - Add a workflow for documenting features job-scheduler#174
• anomaly-detection-dashboards-plugin - Add a workflow for documenting features anomaly-detection-dashboards-plugin#250
• performance-analyzer-rca - Add a workflow for documenting features performance-analyzer-rca#171
• common-utils - Add a workflow for documenting features common-utils#161
• perftop - Add a workflow for documenting features perftop#50

[dblock]

@VachaShah you know how these work if you're looking to do more similar work ;)

[VachaShah]

@VachaShah you know how these work if you're looking to do more similar work ;)

I will take a look at this one @dblock!

[VachaShah]

You can assign it to me, I don't think I have the permissions to assign this.

[dblock]

@CEHENKLE

[VachaShah]

@dblock Should we close this issue since opensearch-project/OpenSearch#2929 is merged?

[dblock]

It needs to be documented, maybe in in https://github.com/opensearch-project/opensearch-plugins or project-meta, and create a campaign to add it everywhere?

[VachaShah]

Sure I added a PR to document this opensearch-project/opensearch-plugins#141. Will this issue serve as a campaign or should I create a new one?

[dblock]

You can definitely turn this issue into a campaign, no need to open something new! Tag it for 2.1 and label accordingly.

[peternied]

@VachaShah It looks like all the repositories need to do the same work, instead of working with all of the repo owners to implement this separately - could we cut pull requests with meta that make the code change rather than create issues?

[VachaShah]

@VachaShah It looks like all the repositories need to do the same work, instead of working with all of the repo owners to implement this separately - could we cut pull requests with meta that make the code change rather than create issues?

@peternied Very sorry for a delayed response. Sure I will give it a try with meta.

[VachaShah]

@VachaShah It looks like all the repositories need to do the same work, instead of working with all of the repo owners to implement this separately - could we cut pull requests with meta that make the code change rather than create issues?

@peternied Very sorry for a delayed response. Sure I will give it a try with meta.

Created PRs for all the repos in the list.

[peternied]

@VachaShah Check in on this campaign, where did it land? Looks like there was discussion on a version of this pull request in the security repo that you were going to circle back on.

• Adding workflow for creating documentation issues security#1857