[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14083861#comment-14083861
]
Yan Fang commented on SAMZA-259:
--------------------------------
two suggestions:
1) Do we use "latest" instead of "master" as the version name to reflect
whatever happens in the master branch of Samza? Because then it will have the
same meaning as in hello-samza -- "latest" branch in hello-samza maps to the
master branch of Samza too. At the same time, "latest" may make more sense to
non-git users. Or use "Nightly" ? like here http://www.rust-lang.org
2) Ideally, I would like this kind of display:
* when user's mouse hovers on document/hello-samza/tutorial, the site will show
two tabs -- one for "latest"(or "nightly") and one for latest release (that is
"0.7.0" for now, and "0.8.0" for seeable future)
* in the Archive category, we put all the documents of all releases that are
older than latest release. e.g. it's empty now. When we have 0.8.0 release,
will put the 0.7.0 there. When we have 0.9.0 release, will put 0.8.0, 0.7.0
there.
> Restructure documentation folders
> ---------------------------------
>
> Key: SAMZA-259
> URL: https://issues.apache.org/jira/browse/SAMZA-259
> Project: Samza
> Issue Type: Bug
> Components: docs
> Affects Versions: 0.6.0
> Reporter: Chris Riccomini
> Assignee: Yan Fang
> Fix For: 0.8.0
>
> Attachments: SAMZA-259.patch
>
>
> Currently, we have hard-coded versions in the documentation path. When we
> bump versions we have to manually create a new subfolder called 0.8.0, and
> update all links to point to this version. A better approach is probably do
> what [rust|http://www.rust-lang.org/] does: use branches to build multiple
> versions of documentation. We already have an 0.7.0 branch, and we've got
> master. This very much mirrors Rust's structure:
> http://static.rust-lang.org/doc/master/tutorial.html
> http://static.rust-lang.org/doc/0.10/tutorial.html
> This structure shouldn't change the paths in the website. All that it means
> is that we'll have:
> * http://samza.incubator.apache.org/startup/hello-samza/master/
> * http://samza.incubator.apache.org/startup/hello-samza/0.7.0/
> * http://samza.incubator.apache.org/learn/documentation/master/
> * http://samza.incubator.apache.org/learn/documentation/0.7.0/
> * http://samza.incubator.apache.org/learn/tutorials/master/
> * http://samza.incubator.apache.org/learn/tutorials/0.7.0/
> This is better for SEO, as well, since everyone will link to master, which
> will always reflect up-to-date information. With our current setup,
> everything that links to 0.7.0 will be outdated when we release docs with
> 0.8.0.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
