You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/12/15 01:19:13 UTC
nifi-site git commit: NIFI-1122: - Reorganizing the README to attempt
to address the formatting issues.
Repository: nifi-site
Updated Branches:
refs/heads/master e00b214ee -> 849e0666d
NIFI-1122:
- Reorganizing the README to attempt to address the formatting issues.
Project: http://git-wip-us.apache.org/repos/asf/nifi-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi-site/commit/849e0666
Tree: http://git-wip-us.apache.org/repos/asf/nifi-site/tree/849e0666
Diff: http://git-wip-us.apache.org/repos/asf/nifi-site/diff/849e0666
Branch: refs/heads/master
Commit: 849e0666d11a6cf900dfdb8d8669660a2ef9476b
Parents: e00b214
Author: Matt Gilman <ma...@gmail.com>
Authored: Mon Dec 14 19:18:56 2015 -0500
Committer: Matt Gilman <ma...@gmail.com>
Committed: Mon Dec 14 19:18:56 2015 -0500
----------------------------------------------------------------------
README.md | 107 ++++++++++++++++++++++++++-------------------------------
1 file changed, 48 insertions(+), 59 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi-site/blob/849e0666/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4781bc7..0781a08 100644
--- a/README.md
+++ b/README.md
@@ -13,26 +13,19 @@
limitations under the License.
-->
# About
-[Apache NiFi project] (http://nifi.apache.org).
+[Apache NiFi project] (http://nifi.incubator.apache.org).
-## Getting Started
+## Setting up Build Environment
-The site is built using grunt task runner, bower package manager for
-the web, and npm package manager for node. npm is used to manage the
-node modules required for building this site. bower is used to manage the
+The site is built using [grunt][] task runner, [bower][] package manager for
+the web, and [npm][] package manager for node. npm is used to manage the
+node modules required for building this site. bower is used to manage the
front end packages that the site will depend on.
-Before installing bower and grunt, the NodeJS Package Manager (npm) must
-be installed. For instructions on installing npm, see npm-install
+Both grunt and bower can be installed via npm once it is installed.
-Both grunt and bower can be installed via npm once, it is installed.
-
-
-```
+```bash
sudo npm install -g grunt-cli
-```
-
-```
sudo npm install -g bower
```
@@ -50,85 +43,82 @@ command from the nifi-site directory.
npm install
```
-The site is built using [foundation][], a responsive front end framework.
+The site is built using [foundation][] a responsive front end framework.
Consequently, the site is using [sass][] and [compass][] for CSS pre-processing.
-This will also require ruby to be installed, as it is a a pre-requisite for sass and compass.
+This will also require ruby to be installed along with sass and compass. Please
+follow the appropriate steps for installing Ruby in your environment.
-After installing Ruby, sass can be installed via:
-```
-gem install sass
-```
+Only Ruby is installed, both sass and compass can be installed via ruby gem with
+the following command.
-Compass will require that the `ruby-devel` package also be installed. This is typically
-accomplished by running
-
-```
-sudo yum install ruby-devel
+```bash
+gem install compass
```
-for Fedora users or
+Additionally, deploying the site will require SVN 1.6+.
-```
-sudo apt-get install ruby-dev
-```
+[grunt]: http://gruntjs.com/
+[bower]: http://bower.io/
+[npm]: http://www.npmjs.com/
+[foundation]: http://foundation.zurb.com/
+[sass]: http://sass-lang.com/
+[compass]: http://compass-style.org/
-for Ubuntu users.
+### Linux Environments
-The compass gem can then be installed:
+Users running on Linux may need to install the ruby development package using
+one of the following commands.
+```bash
+sudo yum install ruby-devel
```
-gem install compass
+```bash
+sudo apt-get install ruby-dev
```
-For Ubuntu users, it may also be necessary to install the `nodejs-legacy` package in order for
+Additionally, it may also be necessary to install the `nodejs-legacy` package in order for
grunt to run properly:
-```
+```bash
sudo apt-get install nodejs-legacy
```
-
-Now that the necessary gems are installed, it is important that the gems' executable directory is
+Once the necessary gems are installed, it is important that the gems' executable directory is
in the user's PATH. For example:
-```
+```bash
export PATH=$PATH:/home/username/bin
```
**NOTE:** it is important that the fully qualified directory name be used. Simply using `~/bin` will
result in errors when running Grunt, such as:
-```Running "compass:dist" (compass) task```
+```
+Running "compass:dist" (compass) task
+```
-```Warning: You need to have Ruby and Compass installed and in your system PATH for this task to work.
- More info: https://github.com/gruntjs/grunt-contrib-compass Use --force to continue.
+```
+Warning: You need to have Ruby and Compass installed and in your system PATH for this task to work.
+More info: https://github.com/gruntjs/grunt-contrib-compass Use --force to continue.
```
```
- Aborted due to warnings.
+Aborted due to warnings.
```
It is recommended that you update your environment's configuration so that this is always in your PATH,
as this will be required every time that grunt is run.
-[grunt]: http://gruntjs.com/
-[bower]: http://bower.io/
-[npm]: http://www.npmjs.com/
-[foundation]: http://foundation.zurb.com/
-[sass]: http://sass-lang.com/
-[compass]: http://compass-style.org/
-[npm-install]: https://github.com/joyent/node/wiki/installing-node.js-via-package-manager
-
## Grunt Tasks
-To build the site run the default grunt task. This will assemble the site and
+To build the site run the default grunt task. This will assemble the site and
place the resulting site in the dist folder. Part of this assembly is actually
-building the various guides and Rest Api documentation bundled in the application.
-Because of this, Maven must be installed and available on the PATH. Additionally Java
-must be installed in order for the Maven build to succeed. Refer to the [NiFi][]
-documentation for minimum requirements for Maven and Java.
+building the various guides and Rest Api documentation bundled in the application.
+Because of this, Maven must be installed and available on the PATH. Additionally Java
+must be installed in order for the Maven build to succeed. Refer to the [NiFi][]
+documentation for minimum requirements for Maven and Java.
-[NiFi]: https://nifi.apache.org/quickstart.html
+[NiFi]: https://nifi.incubator.apache.org/quickstart.html
```bash
grunt
@@ -158,8 +148,8 @@ proceed with the commit, or abort.
### src/includes
-Contains fragments that will be included on all pages of the site. Most notably
-here is the topbar.hbs that defines the Menus on the top of the site. If a new
+Contains fragments that will be included on all pages of the site. Most notably
+here is the topbar.hbs that defines the Menus on the top of the site. If a new
page is being added or removed it is done here.
### src/pages/html
@@ -209,5 +199,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
-limitations under the License.
-
+limitations under the License.
\ No newline at end of file