[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14098227#comment-14098227
]
Yan Fang commented on SAMZA-259:
--------------------------------
Thank you. Committed to master and 0.7.0. Committing to 0.7.0 is because we
need to regenerate 0.7.0's pages with new default layout.
There are two nits:
1. if a page does not exist in previous version, clicking the switch button
changes nothing but the version number in the url. It's not ideal, but
acceptable, I think. Also, seems there is no easy solution. See [Spark
streaming
comparison|http://samza.incubator.apache.org/learn/documentation/latest/comparisons/spark-streaming.html]
2. whenever we update old version's docs (docs in not-master branches) and
publish-site.sh to SVN, we need to re-run the publish-site.sh in the master
branch to update the non-versioned pages, such as Download, Committers.
Otherwise, the non-versioned pages will be override by the old version's
publish-site.sh. This is ok, I think. Because we are suppose to only update the
latest (master) docs. Rewriting previous version's docs is very rare unless
there is vital mistakes or we fix very important bugs.
> 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.4.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)
