[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14078581#comment-14078581
]
Chris Riccomini commented on SAMZA-259:
---------------------------------------
Yeah, I agree.
Here's my half-thought-out proposal:
# Rename all directories from 0.7.0 to "versioned" for all subdirectories in
docs. This will be a keyword to denote that everything under the directory is
versioned by branch.
# Add a version: 0.7.0 (or 0.8.0) in docs/_config.yml.
# Replace all hard-coded version numbers in HTML with {{ site.version }}.
# Update publish-site.sh to include a new variable: VERSIONED_BRANCHES.
VERSIONED_BRANCHES should be a list of: 0.7.0, master. Use this variable to
check out each branch, run generate-javadocs.sh, and bundle exec jekyll build.
From there, the script should merge everything into the checked-out SVN
directory, appropriately replacing the "versioned" directories with their
proper name (based on VERSIONED_BRANCHES value). For example, when
img/versioned/learn is copied in, it should be copied as img/0.7.0/learn for
the 0.7.0 branch, and img/master/learn for the master branch.
Does this make sense?
> 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
> Fix For: 0.8.0
>
>
> 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)
