Editing pass for the Actuator section #27759
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
philwebb
added
type: documentation
philwebb
reviewed
Aug 18, 2021
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/cloud-foundry.adoc
Outdated
Show resolved
Hide resolved
|
Sorry, I typo'd the issue number in the message for 6be27e2. |
philwebb
reviewed
Aug 23, 2021
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/jmx.adoc
Outdated
Show resolved
Hide resolved
wilkinsona
requested changes
Aug 24, 2021
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
Outdated
Show resolved
Hide resolved
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
Outdated
Show resolved
Hide resolved
Buzzardo
force-pushed
the
editing-actuator
branch
from
4675eee to
a208727
Compare
Including removing the ==== fences around code blocks.
Buzzardo
force-pushed
the
editing-actuator
branch
from
a208727 to
c3b268d
Compare
philwebb
pushed a commit
that referenced
this pull request
Sep 9, 2021
Improve consistency of the asciidoctor markup and formatting for the actuator section. See gh-27759
philwebb
pushed a commit
that referenced
this pull request
Sep 9, 2021
Update example lead-in text to a slightly shorter form. For example "as shown in the following example" Becomes "as the following example shows" See gh-27759
philwebb
pushed a commit
that referenced
this pull request
Sep 9, 2021
Edit the actuator docs so that more "You can..." phrasing is used. For example "Auditing can be enabled by providing" becomes "You can enable auditing by providing" See gh-27759
philwebb
pushed a commit
that referenced
this pull request
Sep 9, 2021
16 tasks
|
Thanks @Buzzardo. I've rebased this PR and split it up into a number of smaller commits before pushing. I'm keen to try and improve the consistency across the board for the documentation so I've opened #27895 and tried to identify a bunch of changes that we can make (based on things observed in this PR). Please feel free to add any more that you think of. I think if we can make those broad cross-cutting changes first (and one at a time) it should make the actual editing commits smaller and much easier to review. |
philwebb
added
type: task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.