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

Latest sitegen and functional docs improvements #4463

Merged
merged 42 commits into from
Jul 6, 2022

Conversation

romain-grecourt
Copy link
Contributor

Doc Updates

Latest sitegen-maven-plugin

  • Better nav composition (supports "flattening")
  • Better error reporting !! (aggregated errors, pseudo stack trace)
  • Nav processing happens first (fail-fast, opposed to post rendering)
  • Strict error checking !! (xrefs, warnings)
  • Tool-chain alignment for better productivity
    • allow use of other standard rendering: IntelliJ, asciidoctor cli, GitHub etc.

Functional doc changes

  • Updated xref syntax (from <<file.adoc,tex>> to xref:file.adoc[text])
  • Fixed all broken references
  • Enumerate pages in nav to declare the ordering (instead of using natural sorting and prefixes)
  • Removed XX_ prefixes !!!
  • Sorted rendering (more predictable)
  • Page naming convention (dash separated is the now the norm)
  • Conventions for includes, everything is derived from {rootdir}
    • Every pages MUST define :rootdir: AND include one of includes/attributes.adoc, includes/se.adoc, includes/mp.adoc
    • Common attributes (includes/attributes.adoc) ; contains versions, versioned URLs (specs, javadocs etc.)
  • Flavor attributes (includes/se.adoc, includes/mp.adoc) ; includes includes/attributes.adoc and sets flavor specific attributes

@romain-grecourt romain-grecourt marked this pull request as ready for review July 1, 2022 19:22
@romain-grecourt romain-grecourt requested a review from barchetta July 1, 2022 19:39
barchetta
barchetta previously approved these changes Jul 1, 2022
barchetta
barchetta previously approved these changes Jul 1, 2022
barchetta
barchetta previously approved these changes Jul 5, 2022
Copy link
Contributor

@danielkec danielkec left a comment

Choose a reason for hiding this comment

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

Streams, Messaging and LRA look ok

@romain-grecourt romain-grecourt merged commit f4833ea into helidon-io:master Jul 6, 2022
@romain-grecourt romain-grecourt deleted the doc-updates branch July 6, 2022 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants