You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@storm.apache.org by ptgoetz <gi...@git.apache.org> on 2014/11/26 20:46:36 UTC
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
GitHub user ptgoetz opened a pull request:
https://github.com/apache/storm/pull/330
STORM-567: Move Storm Documentation/Website from SVN to git
This is a work in progress on migrating the storm website/documentation to git in order to make it easier for the community to contribute updates. If there is enough interest in contributing, we can create a feature branch to better enable collaboration.
This is more or less a straight copy of the current website content, with the following enhancements:
* Use bootstrap for layout to make docs mobile/tablet friendly
* Restore syntax highlighting for code snippets
* add a documentation index page listing all doc links.
I haven't worked on branding (e.g. integrating the official logo, color themes, etc.).
I'd love collaborate if anyone is interested, especially anyone with better front-end skills than I. ;)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ptgoetz/storm documentation
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/storm/pull/330.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #330
----
commit ebb48e393485d38fe906e81c0d0162e32d3b5d6a
Author: P. Taylor Goetz <pt...@gmail.com>
Date: 2014-11-26T19:16:30Z
add docs directory and WIP on website/documentation migration to git
commit 1ef421ff59563ab5e3341c5e5bd1c9b1a685ec1e
Author: P. Taylor Goetz <pt...@gmail.com>
Date: 2014-11-26T19:18:11Z
add jekyll _site directory to .gitignore
commit ce25aa5710d2692cac64a7820d5cf10279e10a09
Author: P. Taylor Goetz <pt...@gmail.com>
Date: 2014-11-26T19:20:38Z
add link to documentation index
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/storm/pull/330
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by nathanmarz <gi...@git.apache.org>.
Github user nathanmarz commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-64856690
+1
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by revans2 <gi...@git.apache.org>.
Github user revans2 commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-65801181
@ptgoetz any update on this?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by revans2 <gi...@git.apache.org>.
Github user revans2 commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-64707784
For the most part it looks great.
It looks like we could use some license headers in some of the files.
My only other comment would be to add in a README.md or update the DEVELOPER.md to indicate how to build the documentation, just like you did in the previous comment, but you might want to put something like "after building the generated site will show up in a directory named _site"
I would like to see this go in sooner rather than later. I don't see a reason for a feature branch, unless there is something preventing us from doing so.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by ptgoetz <gi...@git.apache.org>.
Github user ptgoetz commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-64701658
I should also mention the site is statically generated using [jekyll](http://jekyllrb.com).
First install jekyll (assuming you have ruby installed):
```
gem install jekyll
```
Generate the site, and start a server locally:
```
cd docs
jekyll serve -w
```
Point your browser to http://localhost:4000
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by ptgoetz <gi...@git.apache.org>.
Github user ptgoetz commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-65824578
@revans2 Merged. I also added a README with instructions for generating and publishing.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] storm pull request: STORM-567: Move Storm Documentation/Website fr...
Posted by HeartSaVioR <gi...@git.apache.org>.
Github user HeartSaVioR commented on the pull request:
https://github.com/apache/storm/pull/330#issuecomment-64840972
Looks great to me!
I'm interested on documentation, but not having front-end skill.
Just 2 cents, actually content is most important part of documentation, and I filed an issue because of outdated contents from current website, I'd like to see this go sooner, too.
When it merged to some branches, I'll request some fixs for pull.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---