[
https://issues.apache.org/jira/browse/JAMES-3226?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17168308#comment-17168308
]
Ioan Eugen Stan commented on JAMES-3226:
----------------------------------------
Thanks.
Antora allows us to have an index page in the playbook, see
https://docs.antora.org/antora/2.3/playbook/site-start-page/
We can put whatever content we want there, including this list.
I think this should be kept in james-site .
Also, I'm more focused on migrating (and verifing) the existing documentation
to asciidoc/antora.
Once we have that it's going to be much more clear how the structure is going
to look.
Some antora component renaming might be in order.
The current name for james-project component is `main` which IMO should change
to james-project (or even to james-server ?!).
> Provide a process around documentation publishing and deployment
> ----------------------------------------------------------------
>
> Key: JAMES-3226
> URL: https://issues.apache.org/jira/browse/JAMES-3226
> Project: James Server
> Issue Type: Sub-task
> Reporter: Ioan Eugen Stan
> Assignee: Ioan Eugen Stan
> Priority: Major
> Attachments: Captură de ecran de la 2020-07-31 02-34-10.png
>
>
> 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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
