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

Polish reference documentation #38942

Closed
wants to merge 14 commits into from
Closed

Conversation

724thomas
Copy link
Contributor

@724thomas 724thomas commented Dec 29, 2023

This pull request addresses a series of minor typos and phrasing inconsistencies identified in few sections of documentation. Primary objective is to enhance overall clarity and readability of documentation, enhancing the user experience for developers and contributors.

The modification encompasses the following documentation files:

  • batch.adoc
  • data-initialization.adoc
  • docker-compose.adoc
  • logging.adoc
  • nosql.adoc
  • security.adoc
  • testing.adoc

I have reviewed and updated these files so that the language is precise, clear and consistent.

Impact Assessment:
These changes are confined exclusively to documentation content.
There is no impact on the functional aspects of the code.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Dec 29, 2023
@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Dec 29, 2023
@philwebb philwebb self-assigned this Dec 29, 2023
@philwebb philwebb added this to the 3.3.x milestone Dec 29, 2023
@wilkinsona wilkinsona changed the title Fix: Enhance Documentation for Clarity and Readability Polish reference documentation Jan 2, 2024
@724thomas 724thomas closed this Jan 8, 2024
@724thomas 724thomas deleted the Typos branch January 8, 2024 21:26
@philwebb
Copy link
Member

philwebb commented Jan 8, 2024

@724thomas Did you mean to close this one?

@724thomas
Copy link
Contributor Author

@724thomas Did you mean to close this one?

yes. It's been 2weeks and thought that I might've done something wrong..?

@philwebb
Copy link
Member

philwebb commented Jan 9, 2024

If you can reopen it that would be great. There's nothing wrong, we just haven't got around to merging it yet.

@wilkinsona wilkinsona removed this from the 3.3.x milestone Jan 9, 2024
@724thomas 724thomas restored the Typos branch January 9, 2024 19:11
@724thomas 724thomas reopened this Jan 9, 2024
@724thomas
Copy link
Contributor Author

If you can reopen it that would be great. There's nothing wrong, we just haven't got around to merging it yet.

oh, good to know :) I will be patient.
I reopened the pr request

@philwebb philwebb added this to the 3.2.x milestone Jan 16, 2024
philwebb pushed a commit that referenced this pull request Jan 16, 2024
Address a series of minor typos and phrasing inconsistencies
identified in few sections of documentation to enhance overall
clarity and readability.

See gh-38942
philwebb added a commit that referenced this pull request Jan 16, 2024
@philwebb philwebb closed this in 57f2960 Jan 16, 2024
@philwebb philwebb modified the milestones: 3.2.x, 3.2.2 Jan 16, 2024
@philwebb
Copy link
Member

Thanks very much @724thomas, I've merged this to 3.2.x and forward. I did change "in the classpath" back to "on the classpath" since that's the common phasing in my experience.

@724thomas
Copy link
Contributor Author

724thomas commented Jan 16, 2024

Thanks very much @724thomas, I've merged this to 3.2.x and forward. I did change "in the classpath" back to "on the classpath" since that's the common phasing in my experience.

Thank you for the review, @philwebb.

I appreciate your feedback and the update on my pull request. However, I am a bit unclear about one aspect of the current status of my contribution. Could you please confirm if this pull request has also been merged to project? This PR is closed rather than merged.

I apologize for any inconvenience this request for clarification might cause. Thank you for your time and assistance.

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

Successfully merging this pull request may close these issues.

4 participants