NIFI-592: - Updating readme. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/3f3fe3c3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/3f3fe3c3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/3f3fe3c3
Branch: refs/heads/develop Commit: 3f3fe3c359c2bfdff55a08b46087974d5ad49c23 Parents: 951cff9 Author: Matt Gilman <[email protected]> Authored: Wed May 13 19:27:06 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Wed May 13 19:27:06 2015 -0400 ---------------------------------------------------------------------- nifi-site/README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/3f3fe3c3/nifi-site/README.md ---------------------------------------------------------------------- diff --git a/nifi-site/README.md b/nifi-site/README.md index 05cabd0..d3e2e48 100644 --- a/nifi-site/README.md +++ b/nifi-site/README.md @@ -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 @@ -114,6 +150,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
