You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by "Ioan Eugen Stan (Jira)" <se...@james.apache.org> on 2020/06/17 17:35:00 UTC

[jira] [Assigned] (JAMES-3226) Provide a process around documentation publishing and deployment

     [ https://issues.apache.org/jira/browse/JAMES-3226?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ioan Eugen Stan reassigned JAMES-3226:
--------------------------------------

    Assignee: Ioan Eugen Stan

> 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
>
> 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: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org