search

opensearch-project / opensearch-plugins

For all things OpenSearch plugins. You want to install, or develop a plugin? You've come to the right place.
Apache License 2.0
49 stars 61 forks source link

Adding documentation for auto create issue workflow #141

Closed VachaShah closed 2 years ago

VachaShah commented 2 years ago

Signed-off-by: Vacha Shah vachshah@amazon.com

Description

Adding documentation for auto creating issues in documentation-website repo when a label needs-documentation is added on a PR.

Issues Resolved

Related opensearch-project/project-meta#43

Check List

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

dblock commented 2 years ago

At the very least this and BACKPORTs should be linked from README, but how do you feel about combining these workflows into a single file called WORKFLOWS or adding them to BUILDING.md?

VachaShah commented 2 years ago

At the very least this and BACKPORTs should be linked from README, but how do you feel about combining these workflows into a single file called WORKFLOWS or adding them to BUILDING.md?

Adding them to a common md file sounds good! BUILDING.md looks like it serves a different purpose, adding them to WORKFLOWS since there are already 3 workflows - backport, labels, documentation issues.

saratvemulapalli commented 2 years ago

Lately we have been pushing in developer documentation here which has wider scope (i.e core, plugins, dashboards, clients etc) May be the right time to think about switching over to opesearch-project/.github for future updates? @dblock @VachaShah

VachaShah commented 2 years ago

Lately we have been pushing in developer documentation here which has wider scope (i.e core, plugins, dashboards, clients etc) May be the right time to think about switching over to opesearch-project/.github for future updates? @dblock @VachaShah

True, .github would be a good place to add all of this common documentation.

dblock commented 2 years ago

The .github repo is a template repo for the organization. The repo for documentation that applies to all projects is https://github.com/opensearch-project/project-meta. Some stuff should actually move out of .github.