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 TODO for updating public documentation #10242

Merged

Conversation

BhumikaSaini-Amazon
Copy link
Contributor

@BhumikaSaini-Amazon BhumikaSaini-Amazon commented Sep 26, 2023

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.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff
  • Commit 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.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 26, 2023

Compatibility status:

Checks if related components are compatible with change b06f84a

Incompatible components

Skipped components

Compatible components

Compatible 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]

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.search.SearchWeightedRoutingIT.testStrictWeightedRoutingWithCustomString_FailOpenEnabled

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

Merging #10242 (b06f84a) into main (a8969cb) will decrease coverage by 0.02%.
Report is 7 commits behind head on main.
The diff coverage is 83.63%.

@@             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     
Files Coverage Δ
...src/main/java/org/opensearch/core/index/Index.java 100.00% <ø> (ø)
...luster/metadata/MetadataUpdateSettingsService.java 71.42% <100.00%> (+0.68%) ⬆️
...rg/opensearch/common/settings/ClusterSettings.java 92.85% <ø> (ø)
...rch/index/remote/RemoteSegmentTransferTracker.java 81.10% <100.00%> (+0.17%) ⬆️
...index/shard/CloseableRetryableRefreshListener.java 81.03% <100.00%> (+0.67%) ⬆️
...in/java/org/opensearch/index/shard/IndexShard.java 70.18% <100.00%> (+1.31%) ⬆️
...java/org/opensearch/index/shard/StoreRecovery.java 56.95% <ø> (+0.14%) ⬆️
...earch/index/store/RemoteSegmentStoreDirectory.java 89.67% <100.00%> (+0.26%) ⬆️
...ndex/store/RemoteSegmentStoreDirectoryFactory.java 92.30% <100.00%> (ø)
...search/index/translog/InternalTranslogManager.java 72.22% <100.00%> (+0.19%) ⬆️
... and 13 more

... and 437 files with indirect coverage changes

Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
@BhumikaSaini-Amazon
Copy link
Contributor Author

Thanks @dblock for approving this change! Please could you help add the skip-changelog tag and help with the merge?

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.remotestore.RemoteStoreStatsIT.testStatsOnRemoteStoreRestore
      1 org.opensearch.index.IndexServiceTests.testAsyncTranslogTrimTaskOnClosedIndex

@dblock
Copy link
Member

dblock commented Sep 30, 2023

What do you think about shortening the text and making the link to actually open the issue?

Public documentation issue/PR [created](https://github.com/opensearch-project/documentation-website/issues/new/choose)

@reta reta merged commit e7909fc into opensearch-project:main Oct 3, 2023
@reta reta added the backport 2.x Backport to 2.x branch label Oct 3, 2023
@reta
Copy link
Collaborator

reta commented Oct 3, 2023

What do you think about shortening the text and making the link to actually open the issue?

Public documentation issue/PR [created](https://github.com/opensearch-project/documentation-website/issues/new/choose)

Sorry @dblock I missed your suggestion but we could do followup pull request

opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2023
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>
@dblock
Copy link
Member

dblock commented Oct 3, 2023

@BhumikaSaini-Amazon care to look at my suggestion above please?

rayshrey pushed a commit to rayshrey/OpenSearch that referenced this pull request Oct 3, 2023
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
reta pushed a commit that referenced this pull request Oct 3, 2023
(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>
@BhumikaSaini-Amazon
Copy link
Contributor Author

Hi @dblock,
Thanks! Created #10408 to incorporate the recommended change

deshsidd pushed a commit to deshsidd/OpenSearch that referenced this pull request Oct 9, 2023
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
vikasvb90 pushed a commit to vikasvb90/OpenSearch that referenced this pull request Oct 10, 2023
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
Signed-off-by: Bhumika Saini <sabhumik@amazon.com>
Signed-off-by: Shivansh Arora <hishiv@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants