-
Notifications
You must be signed in to change notification settings - Fork 2k
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 TODO for updating public documentation #10242
Add TODO for updating public documentation #10242
Conversation
Compatibility status:Checks if related components are compatible with change b06f84a Incompatible componentsSkipped componentsCompatible componentsCompatible components: [https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/neural-search.git] |
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## main #10242 +/- ##
============================================
- Coverage 71.11% 71.10% -0.02%
+ Complexity 58188 58169 -19
============================================
Files 4830 4830
Lines 274440 274506 +66
Branches 39993 40002 +9
============================================
+ Hits 195175 195193 +18
- Misses 62897 62953 +56
+ Partials 16368 16360 -8
|
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
6c65de2
to
b06f84a
Compare
Thanks @dblock for approving this change! Please could you help add the |
Gradle Check (Jenkins) Run Completed with:
|
What do you think about shortening the text and making the link to actually open the issue?
|
Sorry @dblock I missed your suggestion but we could do followup pull request |
Signed-off-by: Bhumika Saini <sabhumik@amazon.com> (cherry picked from commit e7909fc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@BhumikaSaini-Amazon care to look at my suggestion above please? |
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
(cherry picked from commit e7909fc) Signed-off-by: Bhumika Saini <sabhumik@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
Signed-off-by: Bhumika Saini <sabhumik@amazon.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>
Description
Changes introduced by various PRs are often supposed to be followed with respective updates to the public documentation, maintained in https://github.com/opensearch-project/documentation-website.
This PR updates the PR template to add a checklist item to ensure we either create a GitHub issue or PR in the documentation repo while reviewing the original code changes PR, to ensure that the public documentation updates to be done are tracked and not missed.
Related Issues
N/A
Check List
New functionality includes testing.New functionality has been documented.New functionality has javadoc addedCommit changes are listed out in CHANGELOG.md file (See: Changelog)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.