Github user revans2 commented on the pull request:
https://github.com/apache/storm/pull/1157#issuecomment-201500082
@abhishekagarwal87 yes I modified most of the docs so they are release
specific and under the docs directory again.
I should add some meta documentation about the docs themselves (I'll try to
take this and update the README.md in all of them.
In subversion release specific documentation is placed under the releases
directory, in a sub directory named after the release. The "current" release
should be pointed to by a symlink in that directory called current.
http://svn.apache.org/viewvc/storm/site/releases/
Inside the git docs directory all of the markdown files are supposed to be
release specific.
I added a jekyll plugin that automates generating data for and about the
release pages.
https://github.com/apache/storm/blob/master/docs/_plugins/releases.rb
It sets three things for all of the release documentation pages.
version - the version number of the
git-tree-base - a link to a directory in github that this version is on
git-blob-base - a link to to where on github that this version is on, but
should be used when pointing to files.
It also sets/augments a dataset for each release. `site.data.releases`
each release in the list includes the following, and each can be set in
`_data/releases.yml` to override what is automatically generated by the plugin.
git-tag-or-branch - tag or branch name on github/apache/storm
git-tree-base - a link to a directory in github that this version is on
git-blob-base - a link to to where on github that this version is on, but
should be used when pointing to files.
base-name - name of the release files to download, without the .tar.gz
has-download - if this is an official release and a download link should be
created.
Also I think I have updated all of the javadoc and github links to point to
the proper place for each release. So 1.0.0-SNAPSHOT is pointing to
org.apache.storm, and 2.0.0-SNAPSHOT is updated to point to java files where
they have moved.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
