mirror of
https://github.com/apache/nifi.git
synced 2025-02-20 17:36:50 +00:00
NIFI-162 all doc components prepped and integrated to build process. Now just to fill in content
This commit is contained in:
joewitt
parent
ac3c3bb4d5
commit
b6f2dd280c
@ -42,7 +42,9 @@
|
||||
<div class="header">General</div>
|
||||
<div id="general-links" class="component-links">
|
||||
<ul>
|
||||
<li class="component-item"><a class="component-link user-guide" href="user-guide/nifi-user-guide.html" target="component-usage">User Guide</a></li>
|
||||
<li class="component-item"><a class="component-link overview" href="html/overview.html" target="component-usage">Overview</a></li>
|
||||
<li class="component-item"><a class="component-link user-guide" href="html/user-guide.html" target="component-usage">User Guide</a></li>
|
||||
<li class="component-item"><a class="component-link admin-guide" href="html/administration-guide.html" target="component-usage">Admin Guide</a></li>
|
||||
</ul>
|
||||
<span class="no-matching no-components hidden">No matching guides</span>
|
||||
</div>
|
||||
@ -106,6 +108,7 @@
|
||||
<div id="developer-links" class="component-links">
|
||||
<ul>
|
||||
<li class="component-item"><a class="component-link rest-api" href="rest-api/index.html" target="component-usage">Rest Api</a></li>
|
||||
<li class="component-item"><a class="component-link developer-guide" href="html/developer-guide.html" target="component-usage">Developer Guide</a></li>
|
||||
</ul>
|
||||
<span class="no-matching no-components hidden">No matching developer guides</span>
|
||||
</div>
|
||||
|
||||
@ -258,8 +258,8 @@ $(document).ready(function () {
|
||||
}
|
||||
});
|
||||
|
||||
// listen for on the rest api and user guide
|
||||
$('a.rest-api, a.user-guide').on('click', function() {
|
||||
// listen for on the rest api and user guide and developer guide and admin guide and overview
|
||||
$('a.rest-api, a.user-guide, a.developer-guide, a.admin-guide, a.overview').on('click', function() {
|
||||
selectComponent($(this).text());
|
||||
});
|
||||
|
||||
|
||||
@ -13,31 +13,31 @@
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-asciidoc</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/asciidoc</directory>
|
||||
</resource>
|
||||
</resources>
|
||||
<outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-asciidoc</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/asciidoc</directory>
|
||||
</resource>
|
||||
</resources>
|
||||
<outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<version>1.5.0</version>
|
||||
<version>1.5.2</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>output-html</id>
|
||||
@ -49,13 +49,19 @@
|
||||
</executions>
|
||||
<configuration>
|
||||
<sourceDirectory>${project.build.directory}/asciidoc</sourceDirectory>
|
||||
<backend>html</backend>
|
||||
<backend>html5</backend>
|
||||
<attributes>
|
||||
<skipFrontMatter>true</skipFrontMatter>
|
||||
<imagesdir>./images</imagesdir>
|
||||
<icons>font</icons>
|
||||
<toc>true</toc>
|
||||
<docVersion>${project.version}</docVersion>
|
||||
<sectanchors>true</sectanchors>
|
||||
<idprefix/>
|
||||
<idseparator>-</idseparator>
|
||||
<docinfo1>true</docinfo1>
|
||||
</attributes>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
<!-- This plugin is used to insert the Apache License into the output HMTL because
|
||||
AsciiDoc doesn't appear to provide a mechanism for doing this. -->
|
||||
<plugin>
|
||||
@ -71,7 +77,7 @@
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<file>${project.build.directory}/generated-docs/nifi-user-guide.html</file>
|
||||
<filesToInclude>${project.build.directory}/generated-docs/**.html</filesToInclude>
|
||||
<regex>true</regex>
|
||||
<regexFlags>
|
||||
<regexFlag>DOTALL</regexFlag>
|
||||
@ -99,6 +105,7 @@ $1
|
||||
</value>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
<plugin>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<configuration>
|
||||
|
||||
34
nifi-docs/src/main/asciidoc/administration-guide.adoc
Normal file
34
nifi-docs/src/main/asciidoc/administration-guide.adoc
Normal file
@ -0,0 +1,34 @@
|
||||
//
|
||||
// Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
// contributor license agreements. See the NOTICE file distributed with
|
||||
// this work for additional information regarding copyright ownership.
|
||||
// The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
// (the "License"); you may not use this file except in compliance with
|
||||
// the License. You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
NiFi System Administrator's Guide
|
||||
=================================
|
||||
|
||||
How to install
|
||||
--------------
|
||||
Installation instructions...
|
||||
|
||||
Best Practice Configuration
|
||||
---------------------------
|
||||
The following are things which are good to check...
|
||||
|
||||
Security Configuration
|
||||
----------------------
|
||||
Two-way SSL...
|
||||
|
||||
Controlling Levels of Access
|
||||
----------------------------
|
||||
Within the web-ui ....
|
||||
43
nifi-docs/src/main/asciidoc/developer-guide.adoc
Normal file
43
nifi-docs/src/main/asciidoc/developer-guide.adoc
Normal file
@ -0,0 +1,43 @@
|
||||
//
|
||||
// Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
// contributor license agreements. See the NOTICE file distributed with
|
||||
// this work for additional information regarding copyright ownership.
|
||||
// The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
// (the "License"); you may not use this file except in compliance with
|
||||
// the License. You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
NiFi Developer's Guide
|
||||
======================
|
||||
|
||||
The designed points of extension
|
||||
--------------------------------
|
||||
Processor, Prioritizer, ...
|
||||
|
||||
The NiFi Archive (NAR) and NiFi Classloading
|
||||
--------------------------------------------
|
||||
A NAR is ...
|
||||
|
||||
How to build extensions
|
||||
-----------------------
|
||||
Understanding Nars the first step is...
|
||||
|
||||
Design considerations
|
||||
---------------------
|
||||
The right abstraction ...
|
||||
|
||||
Consider the User Experience
|
||||
----------------------------
|
||||
The user...
|
||||
|
||||
How to contribute to Apache NiFi
|
||||
--------------------------------
|
||||
Git, Maven, ASF processes, NiFi processes, ...
|
||||
|
||||
31
nifi-docs/src/main/asciidoc/overview.adoc
Normal file
31
nifi-docs/src/main/asciidoc/overview.adoc
Normal file
@ -0,0 +1,31 @@
|
||||
//
|
||||
// Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
// contributor license agreements. See the NOTICE file distributed with
|
||||
// this work for additional information regarding copyright ownership.
|
||||
// The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
// (the "License"); you may not use this file except in compliance with
|
||||
// the License. You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
NiFi Overview
|
||||
=============
|
||||
|
||||
The problem NiFi solves
|
||||
-----------------------
|
||||
Dataflow at scale...
|
||||
|
||||
The design philosophy of NiFi
|
||||
-----------------------------
|
||||
FBP, ...
|
||||
|
||||
Key Features
|
||||
------------
|
||||
UI, compponent-based, high performance, provenance
|
||||
|
||||
@ -14,12 +14,8 @@
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
NiFi User Guide (Draft - Preview Version)
|
||||
=========================================
|
||||
Apache_NiFi_Team
|
||||
:toc:
|
||||
:icons:
|
||||
|
||||
NiFi User Guide
|
||||
===============
|
||||
|
||||
[template="glossary", id="terminology"]
|
||||
Terminology
|
||||
@ -21,8 +21,8 @@
|
||||
<includeBaseDirectory>false</includeBaseDirectory>
|
||||
<fileSets>
|
||||
<fileSet>
|
||||
<directory>${project.build.directory}/generated-docs</directory>
|
||||
<outputDirectory>/user-guide/</outputDirectory>
|
||||
</fileSet>
|
||||
<directory>${project.build.directory}/generated-docs/</directory>
|
||||
<outputDirectory>/html/</outputDirectory>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
</assembly>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user