[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yan Fang updated SAMZA-259:
---------------------------
Attachment: SAMZA-259.2-0.7.0.patch
SAMZA-259.2.patch
Uploaded two patches. The patch for 0.7.0 is a little simplified. Because the
goal of 0.7.0 patch is only to apply the new default layout, which enables
version switch.
Main changes:
1. update font awesome version to 4.1.0, which has the history icon.
2. there is a button in right-up corner to switch versions if the page is
versioned. "latest version" switches to "latest-release" version. All other
versions switches to "latest version"
To test it:
run:
bundle exec jekyll serve --watch
and then in a new command line window, run:
_docs/local-site-test.sh
Currently, you can switch to 0.7.0 from latest, but can not switch back from
0.7.0 to latest, that is because the 0.7.0 pages in SVN have not been using the
new default.html.
RB: https://reviews.apache.org/r/24482/
Thank you.
> 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.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)
