Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-592: 

- Updating readme.
This commit is contained in:
Matt Gilman 2015-05-13 19:27:06 -04:00
parent 951cff9bda
commit 3f3fe3c359
1 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
nifi-site/README.md
View File

@ -62,7 +62,13 @@ gem install compass
## Grunt Tasks
To build the site run the default grunt task. This will assemble the site and
place the resulting site in the dist folder.
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.
[NiFi]: https://nifi.incubator.apache.org/quickstart.html
```bash
grunt
@ -76,6 +82,36 @@ files for changes. Any changes will cause the site to be rebuilt.
grunt dev
```
To deploy new changes to the live site, run the deploy task
```bash
grunt deploy
```
This will go through each step required to deploy changes to the site. Updates
are performed by committing to a SVN repository. This means that svn must be installed
and available on the PATH. Additionally, it requires SVN 1.6+. The deployment
process will show the files being committed and provide an option to view a diff,
proceed with the commit, or abort.
## Source overview
### 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
page is being added or removed it is done here.
### src/pages/html
Contains pages that are written in HTML. If page being added/edited is written is
HTML it resides here.
### src/pages/markdown
Contains pages that are written in Markdown. If the page being added/edited is written
in Markdown it resides here.
## Application Style Properties
### Font
@ -115,5 +151,3 @@ 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.