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

Fix: broken links and typos #4117

Merged
merged 7 commits into from
Oct 11, 2023
Merged

Fix: broken links and typos #4117

merged 7 commits into from
Oct 11, 2023

Conversation

SachinSahu431
Copy link
Contributor

Description

Fix broken links and typographical errors in the existing readme files.

For example this section refers to opensearch-2.8.0-test.yml file, which is no longer available on main branch, and has been moved to opensearch-2.8.0 branch.

There are also some other changes such as removing clearly noticeable typos, unclosed brackets, adding missing link to Slack public release channel, etc.

Issues Resolved

None

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.

Signed-off-by: Sachin Sahu <[email protected]>
Copy link
Member

@gaiksaya gaiksaya left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the documentation and spell checks. Some minor nits. Other wise looks good.

MAINTAINERS.md Outdated Show resolved Hide resolved
MAINTAINERS.md Outdated Show resolved Hide resolved
ONBOARDING.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #4117 (0e21fc5) into main (b8a4bfc) will decrease coverage by 0.28%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4117      +/-   ##
==========================================
- Coverage   93.27%   92.99%   -0.28%     
==========================================
  Files         187      187              
  Lines        5753     5753              
==========================================
- Hits         5366     5350      -16     
- Misses        387      403      +16     

see 2 files with indirect coverage changes

@gaiksaya gaiksaya added the documentation Improvements or additions to documentation label Oct 11, 2023
rishabh6788 and others added 5 commits October 11, 2023 08:35
Signed-off-by: Rishabh Singh <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Signed-off-by: Rishabh Singh <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Signed-off-by: Rishabh Singh <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Signed-off-by: Sachin Sahu <[email protected]>
Copy link
Member

@gaiksaya gaiksaya left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@gaiksaya
Copy link
Member

gaiksaya commented Oct 11, 2023

Hi @SachinSahu431 I am merging this for now. You can try rebasing the git commits squash to 1 from next time. Makes it cleaner.
Also if you are interested in improving the documentation more, we have an open issue to collect all documentation in one place and update the Gh wiki for this repo. See #3936 for more details.
Thanks!

@gaiksaya gaiksaya merged commit c469fb1 into opensearch-project:main Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation first-time-contributor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants