Clean up Reference Documentation #9668
Conversation
spring-projects-issues
added
the
status: waiting-for-triage
|
I can't get the build to work, but I can't get the build to work (with the same errors) on the main branch, either. |
|
@Buzzardo The build is working in our CI. Can you elaborate on
We cannot accept a PR that our build is not passing. |
rwinch
added
in: docs
|
We worked on this offline. It turns out Now this PR needs to be rebased off of main to resolve the conflicts and pick up the changes I have pushed. Then we will be ready to merge. |
|
There. Now it all works. Thanks very much, Rob. One oddity I'd like to point out (to help people searching the topic in the future) is that the build seems to be touchy about the Java version. I fixed the first two errors (with help from @sjohnr - thanks to you, too, Steve) by using 11.0.7.hs-adpt rather than 11.0.9.j9-adpt (both through sdkman). That's why I thought the main branch was broken. Sorry for the confusion, and thanks again. |
spring-projects-issues
added
status: feedback-provided
There was a problem hiding this comment.
Thanks for the pull request. I think going forward it would be helpful if the pull request were broken up a little bit. For example, rather than submitting a pull request with 100+ files with changes split it up into sections. Changes that are grammar changes would be separate from dependency updates, formatting changes, and changes in conventions (proposing switching admonitions syntax).
I've provided feedback inline. Please let me mark a conversation as resolved as this helps me to ensure the changes I was expecting are what was made.
Additionally, I was curious if you had a style guide for the Spring team. For example, when using a code block ensure it is surrounded by ====. I think having these things documented, would help us to ensure the documentation going in was already fairly consistent so you don't have to make PRs fixing our inconsistencies.
docs/manual/src/docs/asciidoc/_includes/about/authentication/password-storage.adoc
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/about/authentication/password-storage.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/about/authentication/password-storage.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/about/exploits/csrf.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-login.adoc
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-login.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-resourceserver.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-resourceserver.adoc
Outdated
Show resolved
Hide resolved
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-resourceserver.adoc
Outdated
Show resolved
Hide resolved
rwinch
added
status: waiting-for-feedback
I went through everything to get it to fit with Spring's docuemntation standard. Lots of small changes for punctuation, grammar, usage, voice, and so on. Also added some links, mostly to the API Javadoc.
A file changed while I was working on it, as the developers added more material for Kotlin. I edited the changes, to make everything be consistent.
The switch to main triggered some conflicts, which I have fixed in this commit.
Fixes to make the build work.
Incorporated suggested changes from a review.
Mostly restoring the formatting of admonitions.
I missed three block delimiters while restoring admonition formatting.
rwinch
removed
the
status: waiting-for-feedback
|
Thanks for the PR @Buzzardo! I've merged this into main |
I did an editing pass on the entire user manual, to make it all be consistent with the other Spring documentation. Aside from the usual spelling, punctuation, and grammar changes, I also added quite a few links to the Javadoc and a few cross-references between sections.