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

Adding documentation for auto create issue workflow #141

Merged
merged 3 commits into from
Apr 25, 2022

Conversation

VachaShah
Copy link
Collaborator

Signed-off-by: Vacha Shah [email protected]

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

  • Commits are signed per the DCO using --signoff

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
Copy link
Member

dblock commented Apr 22, 2022

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
Copy link
Collaborator Author

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.

Signed-off-by: Vacha Shah <[email protected]>
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@saratvemulapalli
Copy link
Member

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

@saratvemulapalli saratvemulapalli merged commit 2432252 into opensearch-project:main Apr 25, 2022
@VachaShah VachaShah deleted the documentation branch April 25, 2022 22:39
@VachaShah
Copy link
Collaborator Author

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
Copy link
Member

dblock commented Apr 26, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants