[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14096612#comment-14096612
]
Yan Fang commented on SAMZA-259:
--------------------------------
{quote}
It's in the way upper right, using the ra-history icon!
{quote}
Personally I feel it is not very user-friendly. I tried to use text, such as
"switch to 0.7.0". That is intolerable ugly. :( . Therefore, I go with the
fa-history icon. Hope users will like to click it. ;)
{quote}
what happens when we have multiple versions? (e.g. 0.7.0, 0.8.0, and latest)?
{quote}
In my opinion, there are three kinds of versions: (1) latest version that
corresponds to our master branch. It is the default site. (2) latest stable
release version. This is a very important version. It is 0.7.0 now and will be
0.8.0 in the future. (3) other older versions. It's mostly for reference
purpose. It's empty now. But we will have 0.7.0 when we release 0.8.0.
Therefore,
1. If you click the switch version icon in (1) latest version pages, you go to
(2) latest stable release version. Vise versa.
2. If you click the switch version icon in all other version pages, you go to
(1) latest version pages.
So basically, you can switch between the latest stable release version and the
latest (master) version easily. And you can go to the latest (master) version
easily from all older versions. But if you need to go to (3) older versions,
you may need to click the links in "Archive" category in left sidebar. I think
this is fine because we assume users do not need to check older versions
frequently.
> 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.1.patch, SAMZA-259.2-0.7.0.patch,
> SAMZA-259.2.patch, SAMZA-259.3.0.7.0.patch, SAMZA-259.3.patch, 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)
