[
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.patch
This patch is a little big because some directories contain images. Did not put
it into RB because I am not sure how RB deals with binary characters...If it is
ok to put in RB, I can do that.
Changes:
1. rename "0.7.0" to "versioned" in img/, learn/documentations/,
learn/tutorials and startup/hello-samza
2. replace all found /0.7.0 with /{{site.version}}
3. add "version: master" in _config.yml
4. add replace-versioned.sh script in docs directory
5. add calling replace-versioned.sh in bin/publish-site.sh
6. removed the $VERSION in bin/generate-javadoc.sh, because we use "versioned"
for all branches.
7. remove the requirement of inputting version number when run publish-site.sh
8. add a category called "Archive" in _layouts/default.html. That is for
putting links to old version documents.
9. change the link to 0.7.0 in _layouts/default.html to master, because we are
using the master version as the default links for all the sidebars links.
10. add more instruction in README.md.
The way i was testing:
1. comment out last three lines in bin/publish-site.sh
2. run bin/publish-site.sh
3. go to docs, and run bundle exec jekyll serve --watch
4. open another command line window, cp files in $SVN_TMP to _site
Now the 0.0.0.4000 will show how the real sites look like.
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.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)
