Skip to content

SOLR-17622: Fix some typos in the reference guide#3038

Merged
epugh merged 2 commits intoapache:mainfrom
stweil:typos
Jan 17, 2025
Merged

SOLR-17622: Fix some typos in the reference guide#3038
epugh merged 2 commits intoapache:mainfrom
stweil:typos

Conversation

@stweil
Copy link
Contributor

@stweil stweil commented Jan 16, 2025

https://issues.apache.org/jira/browse/SOLR-17622

Description

While reading the documentation I notices several typos.

Solution

I fixed the typos which I found while reading the documentation.
Then I used codespell and typos to find and fix more spelling issues.

Tests

This does not apply.

Checklist

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide

@github-actions github-actions bot added documentation Improvements or additions to documentation tool:build labels Jan 16, 2025
@stweil
Copy link
Contributor Author

stweil commented Jan 16, 2025

Please note that there are lots of more typos in other parts of the repository, for example in code comments. The tools mentioned above can be used to find them.

@stweil stweil changed the title Fix some typos in the reference guide SOLR-17622: Fix some typos in the reference guide Jan 16, 2025
Most of them were found by using `codespell` and `typos`.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
Comment on lines -457 to +459
When omitted, the process will use no credentials (suitable for an unsecure configuration).
When omitted, the process will use no credentials (suitable for an insecure configuration).
* The Credentials Provider uses the credentials of the user with admin privileges on the nodes.
When omitted, the process will use no credentials (suitable for an unsecure configuration).
When omitted, the process will use no credentials (suitable for an insecure configuration).
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "unsecured" instead of "insecure", not sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AI suggests "If omitted, the process will not use credentials (suitable for an insecure configuration)". But I'm not a native English speaker, so I don't know which text is the best.

These suggestions fix more documention issues.

Signed-off-by: Stefan Weil <sw@weilnetz.de>

Co-authored-by: Christine Poerschke <cpoerschke@apache.org>
@epugh epugh merged commit a86d21c into apache:main Jan 17, 2025
3 checks passed
@epugh
Copy link
Contributor

epugh commented Jan 17, 2025

Thank you @stweil for this contribution. Please don't hesitate to tag me in the future on more documentation fixes, I hope you keep working your way through the code base!

@epugh
Copy link
Contributor

epugh commented Jan 17, 2025

Someday maybe we'll have a semi-formal Documentation Team ;-)

@stweil stweil deleted the typos branch January 17, 2025 14:09
epugh pushed a commit that referenced this pull request Jan 17, 2025
Most of them were found by using `codespell` and `typos`.

---------

Signed-off-by: Stefan Weil <sw@weilnetz.de>
Co-authored-by: Christine Poerschke <cpoerschke@apache.org>
(cherry picked from commit a86d21c)
tboeghk pushed a commit to otto-de/solr that referenced this pull request Feb 18, 2026
Most of them were found by using `codespell` and `typos`.

---------

Signed-off-by: Stefan Weil <sw@weilnetz.de>
Co-authored-by: Christine Poerschke <cpoerschke@apache.org>
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 tool:build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants