Details
-
Sub-task
-
Status: In Progress
-
Major
-
Resolution: Unresolved
-
None
-
None
-
None
-
None
Description
We have started working on the documentation and it's great.
We should also document the processes around documentation:
- when we publish the docs
- how to publish the docs
- where to publish the docs
- when we retire old docs ?!
This task should aggregate discussion and decisions.
The process should be written as asciidoc.
We decided to use antora as a documentation system so the features are going to depend on that technology.
We should have documentation for every release we make.
This is important since people don't upgrade immediately after release and might use an older release for some time.
I'm not sure if the documentation for all versions should be online.
We can build zip archives of each documentation release and include it in the binary release or publish them for download next to it.
This way we can keep only the latest 1-3 versions online.
Attachments
Attachments
Issue Links
- is part of
-
JAMES-3258 Update Documentation for version <3.5.0
-
- Open
-
- is related to
-
-
- Resolved
-
- relates to
-
-
- Open
-
- links to
