[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14082609#comment-14082609
]
Yan Fang commented on SAMZA-259:
--------------------------------
{quote}
In the case where we need to go back and update docs for 0.7.0, for example,
in your proposal, will that step be automated, or is it going to require
manually copying over just the versioned directories?
{quote}
In my proposal, you will have to 1) switch to 0.7.0 branch 2) run
publish-site.sh 3) switch to master 4) run publish-site.sh. That is because
when we run publish-site.sh in step 2, all unversioned documents will use what
0.7.0 branch has and so we have to recover them to master by running 4.
If we want to update both 0.7.0 and master by running one publish-site.sh, we
may need to switch branch. If we have umcommitted code in one branch, it seems
problematic.
> 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)
