Skip to content

Helidon 3.0 Documentation

Jump to bottom
David Král edited this page Jun 15, 2022 · 2 revisions

We will take two step process:

For Helidon 3.0

  • We use the same build-tools machinery as for Helidon 2.x.
  • We are keeping the same left panel structure as the current documentation
  • Clickable second-level menu
  • New format of documentation documents

After Helidon 3.0 release:

  • Update the web site to make clear flavors separation
  • Split documentation to MP, SE and Nima
  • New build-tools machinery for rendering documentation

How to proceed

  • Get a documentation task from this board
  • Find the corresponding modified Asciidoc file in Mitia's PR. It's your primary source. You'll modify it and at the end commit to master.
  • Find TODO items and fill the gaps.
    • It's acceptable that your final file won't contain some sections listed in Mitia's merged documents.
    • API and Reference sections are optional.
    • MicroProfile related documentation should contain links to the specification pdf and the specification API repository.
  • Use Tomas' tool to generate a files containing tables with configuration properties based on source code annotations. Include (not copy/paste!) the generated file to your document. More information about how to use it is here.
  • Update the issue, tick all check boxes for completed tasks, add comments and TODO's for future updates.
  • Submit a PR

References

Clone this wiki locally