[jira] [Commented] (NIFI-3513) Publish versioned documentation

["Andy LoPresto (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFI-3513?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16526753#comment-16526753 ] 

Andy LoPresto commented on NIFI-3513:
-------------------------------------

The documentation pages should also allow for easy switching between versions (i.e. a dropdown menu which lists the available versions). Some components will not have a page available for a specific version. 

> Publish versioned documentation
> -------------------------------
>
>                 Key: NIFI-3513
>                 URL: https://issues.apache.org/jira/browse/NIFI-3513
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>            Reporter: Andy LoPresto
>            Priority: Minor
>              Labels: archive, documentation, versioning
>
> While NiFi is slightly different from most software projects in that every deployment contains a copy of the relevant documentation, it is still valuable to have versioned documentation available online:
> * archive canonical version of documentation
> * allow real-time comparison between versions
> * allow access to documentation without spinning up instance of NiFi locally
> I would propose a structure like the following but am open to other suggestions:
> * /docs/0.7.2/index.html
> * /docs/1.1.2/index.html
> * /docs/latest/index.html -> /docs/1.1.2/index.html
> * /docs.html -> /docs/latest/index.html
> The latter two redirects would be updated when a new release is published (only /latest/index.html would need to be manually updated). 
> The docs pages should also be updated to prominently display the version (I believe I have seen this in another browser, but in both Chrome and Firefox I do not see the version number in the HTML content anywhere). 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)