Documentation for Helidon (Master Epic)

[m0mus]

This epic collects all documentation task for Helidon 2.0.

• Refactor documentation structure. Separate Helidon SE and Helidon MP docs. 1514
• Create Under Construction statement for documentation that is incomplete. 1586

About

• Introduction 1625
  • Helidon purpose in general
  • Helidon goals
  • More about 2 flavors of Helidon
  • Differences between SE and MP
• Guides
  • Restructure Guides page. Separate SE and MP guides.
  • Guide for DB Client 206
  • Guide for Web Client 1627
  • Guide for using static context (Documentation request. How to secure content with StaticContentSupport #1654)
  • Change page names with SE or MP prefix to get it sorted in the TOC panel

SE

• Introduction to Helidon SE 2.0 1626
  • Nice image with components (from slides) or cards 2173
  • Update components list, add links
• Config
  • Reflect Helidon 2.0 changes ----- get updated doc status from Tomas
  • Additional changes for Config 2.0
• DB Client 1629
  • Write docs
• gRPC Server
  • Reflect Helidon 2.0 changes (if any)
• Health Checks
  • Reflect Helidon 2.0 changes (if any)
• Metrics 2196
  • Reflect Helidon 2.0 changes (if any)
  • Cover more use cases.
• OpenAPI Doc: MP/SE content for Open API #2199
  • Reflect Helidon 2.0 changes (if any)
  • Cover more use cases.
• Reactive Web Server
  • Reflect Helidon 2.0 changes (if any)
• Reactive Messaging 1483
• Reactive Streams
• Security Doc: SE Security updates for 2.0 #2203
  • Reflect Helidon 2.0 changes (if any)
• Tracing
  • Reflect Helidon 2.0 changes (if any)
• Web Client 1630
  • Write docs
  • Updates for Web Client doc 1862
• Websocket 1631 Santiago
  • Write docs
• Cross Origin Resource Sharing (CORS) support

MP

• Introduction to Helidon MP 2.0 1628

  • Nice image with components (from slides) or cards 2172
  • Update components list, add links

• Config ---- get updated doc status from Tomas.

  • About MP Config specification
  • Concepts
  • How it's related to Helidon SE Config (partially covered in JAX-RS)
  • Use cases

• CDI Extensions Doc: Update content for MP CDI Extensions #2202

  • Reflect Helidon 2.0 changes (if any)

• gRPC Server

  • Reflect Helidon 2.0 changes (if any)

• Health Checks Doc: MP Health Check changes for 2.0 #2205

  • About MP Health Checks specification
  • Concepts
  • Use cases

• JAX-RS/Jersey

  • About JAX-RS specification and why it's supported
  • Concepts
  • Use cases

• JPA/JTA Doc: MP JPA/JTA updates for 2.0.x #2201

  • There is nothing currently here, but there is some HikariCP and JTA docs under Extensions ---incl a new brief intro
  • How to access databases
  • What is JPA
  • What is JTA
  • How to configure it
  • Use cases

• JWT Auth

  • About the specification
  • Concepts
  • Use cases

• Metrics

  • About the specification
  • Concepts
  • Use cases

• OpenAPI Doc: MP/SE content for Open API #2199

  • About the specification
  • Concepts

• Reactive Messaging 1483

  • About the specification
  • Concepts
  • Use cases

• Reactive Streams

  • About the specification
  • Concepts
  • Use cases

• REST Client Doc: MP Rest Client 2.0.x additional use cases #2200

  • About the specification
  • Concepts

• Security

  • More use cases?

• Tracing 1979

  • About the specification
  • Concepts

• Websocket 1631 Santiago

  • About the specification
  • Concepts
  • Use cases

• Cross Origin Resource Sharing (CORS) support 1632
  Additional Resources

• Community opens in a new window

Other

• How can I change title which is displayed at the top of each page. It displays Se instead of SE.
  LJ - Add h1Prefix: SE or MP to the front matter of your topic

[jagarcia14]

This is a great list!

I think two things would be helpful:

1. Let's develop an "over/under line" for the release; documents required for the release over, and those that can be added after the release under.

2. I am not familiar with the content, so every line in this list is equal with regard to effort and importance. Can we scope these topics in a bit more detail?

[ljamen]

@m0mus ,
I created separate issues for the items that I believe we can get to before the end of April. If there are other P1 (higher priority) items that you want us to attack first, let me know and I'll create tracking issues for those. Vanaja and I will need a dev resource for each item on the list.

[ljamen]

Added tracking issues for each outstanding task in this epic. Work on these issues to be completed for the next 2.0.x update.