-
Notifications
You must be signed in to change notification settings - Fork 566
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
4.x - Externalize and compile documentation java snippets #8294
4.x - Externalize and compile documentation java snippets #8294
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
ba1baeb
to
1537c75
Compare
1537c75
to
eac273c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This brings in a much needed validation of code snippets that will make it easier to keep documentation up to date for our future (and current) releases.
Thanks!
…client transitive dependencies
- Fix xml snippets indentation - Fix usage of [source,java] (remove spaces or capitalization)
- [listing] -> [source, text] - typos ; hyphenated words reported by IntelliJ - MP config snippets - Fix properties snippets (use = instead of : for the key-value separator) - Some normalization of curl request / response (JSON response as a separate block with a nested title 'JSON response') - Add fit role to many images - Fix XML indentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
…#8294) Externalize and compile docs java snippets. Introduce conventions and style for Java snippets across all docs (see helidon-io#8294)
Description
Fixes #8293
Fixes #8313
Externalize and compile docs java snippets.
Introduce conventions and style for Java snippets across all docs (see below).
Documentation
This PR contains docs update only.
Changes
hocon
as the language type for JSON snippets with annotation (syntax:// <1>
)New conventions
.adoc
and.java
(one "Snippets" class for each document)io.helidon.docs
)Snippets
suffix (E.g.reactive-messaging.adoc
->ReactiveMessagingSnippets.java
snippet_{index}
whereindex
is the snippet index in the document (starting at index 1)void snippet_{index} {}
Snippet{Index}
// <1>
) are not padded ; (don't bother aligning them ; it is not something that we can consistently maintain) ; instead they should be separated by a single space characterChanges in snippets
var
keyword is preferred to improve readability unless the type matters for the understanding of the snippet