[SAMZA-259] Restructure documentation folders

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.6.0
• Fix Version/s: 0.8.0
• Component/s: docs
• Assignee: Yan Fang
• Reporter: Chris Riccomini
• Created: 01/May/14 19:51
• Updated: 09/Nov/14 15:57
• Resolved: 15/Aug/14 06:05

Description

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 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.

Issue Links

• is related to: SAMZA-462 Javadocs update