[
https://issues.apache.org/jira/browse/SAMZA-259?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14082494#comment-14082494
]
Chris Riccomini commented on SAMZA-259:
---------------------------------------
bq. I was saying that, we could set VERSIONED_BRANCHE as current branch's name,
or just hard code it. Here, VERSIONED_BRANCHE is not a list, just a version
number, such as master or 0.7.0.
Maybe we can just grep/sed it out of the gradle.properties file then. That way,
we have one source of truth for version info.
bq. Because this script is facing developers, I feel this cost is not high,
compared with the simplicity it gets. Because 0.7.0 branch is not under active
development. Most of the time, we only use master to update pages. Otherwise,
we need to
I'm still a bit unclear here. 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?
> 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)
