Skip to content

A
atlas
Commit 9ebfd1b1 by Shwetha GS
Options

ATLAS-180 Cleanup atlas doc packaging (shwethags)

parent c3453f60
Showing with 99 additions and 74 deletions
distro/src/main/assemblies/standalone-package.xml
......@@ -43,6 +43,11 @@
</fileSet>
<fileSet>
<directory>../target/site/apidocs</directory>
<outputDirectory>docs/apidocs</outputDirectory>
</fileSet>
<fileSet>
<directory>src/bin</directory>
<outputDirectory>bin</outputDirectory>
<fileMode>0755</fileMode>
......
docs/pom.xml
......@@ -32,9 +32,38 @@
<properties>
<skipTests>true</skipTests>
<skipDocs>false</skipDocs>
<skipSite>false</skipSite>
</properties>
<reporting>
<excludeDefaults>true</excludeDefaults>
<outputDirectory>${project.build.directory}/site</outputDirectory>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.4</version>
<configuration>
<skip>${skipDocs}</skip>
<dependencyDetailsEnabled>false</dependencyDetailsEnabled>
<dependencyLocationsEnabled>false</dependencyLocationsEnabled>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>index</report>
<report>project-team</report>
<report>mailing-list</report>
<report>issue-tracking</report>
<report>license</report>
<report>scm</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
<build>
<plugins>
<plugin>
......@@ -44,7 +73,7 @@
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-twiki</artifactId>
<version>1.3</version>
<version>1.6</version>
</dependency>
</dependencies>
<executions>
......@@ -55,28 +84,6 @@
<phase>prepare-package</phase>
</execution>
</executions>
<configuration>
<generateProjectInfo>false</generateProjectInfo>
<generateReports>false</generateReports>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.8.1</version>
<executions>
<execution>
<goals>
<goal>project-team</goal>
<goal>mailing-list</goal>
<goal>cim</goal>
<goal>issue-tracking</goal>
<goal>license</goal>
<goal>scm</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
......
docs/src/site/site.xml
......@@ -77,7 +77,6 @@
<item name="Wiki" href="https://cwiki.apache.org/confluence/display/ATLAS"/>
<item name="News" href="https://cwiki.apache.org/confluence/display/ATLAS"/>
<item name="Git" href="https://git-wip-us.apache.org/repos/asf/incubator-atlas.git" />
<item name="Svn" href="https://svn.apache.org/repos/asf/incubator/atlas" />
<item name="Jira" href="https://issues.apache.org/jira/browse/ATLAS" />
<item name="Powered by" href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy" />
<item name="Blog" href="http://blogs.apache.org/atlas/" />
......@@ -99,8 +98,6 @@
</menu>
<menu name="Documentation">
<!-- current points to latest release -->
<item name="current" href="./index.html"/>
<item name="0.5-incubating" href="./0.5.0-incubating/index.html"/>
</menu>
......
docs/src/site/twiki/Architecture.twiki
......@@ -14,14 +14,14 @@ The hook can then build the entity and register the entity using Atlas REST APIs
Atlas exposes notification interface and can be used for reliable entity registration by hook as well. The hook can send notification message containing the list of entities to be registered. Atlas service contains hook consumer that listens to these messages and registers the entities.
Available bridges are:
* [[hive/Bridge-Hive][Hive Bridge]]
* [[Bridge-Hive][Hive Bridge]]
---++ Notification
Notification is used for reliable entity registration from hooks and for entity/type change notifications. Atlas, by default, provides kafka integration, but its possible to provide other implementations as well. Atlas service starts embedded kafka server by default.
Atlas also provides NotificationHookConsumer that runs in Atlas Service and listens to messages from hook and registers the entities in Atlas.
<img src="images/twiki/notification.png" height="100" width="150" />
<img src="images/twiki/notification.png" height="10" width="20" />
......
docs/src/site/twiki/Bridge-Hive.twiki
......@@ -22,6 +22,7 @@ hive_process(ClassType) - super types [Process] - attributes [startTime, endTime
The entities are created and de-duped using unique qualified name. They provide namespace and can be used for querying as well:
hive_db - attribute qualifiedName - clustername.dbname
hive_table - attribute name - clustername.dbname.tablename
hive_column - attribute qualifiedName - clustername.dbname.tablename.columnname
hive_partition - attribute qualifiedName - clustername.dbname.tablename.partitionvalues
hive_process - attribute qualifiedName - queryText
......
docs/src/site/twiki/index.twiki
......@@ -11,8 +11,7 @@ allows integration with the whole enterprise data ecosystem.
---+++ Data Classification
* Import or define taxonomy business-oriented annotations for data
* Define, annotate, and automate capture of relationships between data sets and underlying
elements including source, target, and derivation processes
* Define, annotate, and automate capture of relationships between data sets and underlying elements including source, target, and derivation processes
* Export metadata to third-party systems
---+++ Centralized Auditing
......@@ -21,21 +20,18 @@ allows integration with the whole enterprise data ecosystem.
---+++ Search & Lineage (Browse)
* Pre-defined navigation paths to explore the data classification and audit information
* Text-based search features locates relevant data and audit event across Data Lake quickly
and accurately
* Browse visualization of data set lineage allowing users to drill-down into operational,
security, and provenance related information
* Text-based search features locates relevant data and audit event across Data Lake quickly and accurately
* Browse visualization of data set lineage allowing users to drill-down into operational, security, and provenance related information
---+++ Security & Policy Engine
* Rationalize compliance policy at runtime based on data classification schemes, attributes
and roles.
* Advanced definition of policies for preventing data derivation based on classification
(i.e. re-identification) – Prohibitions
* Rationalize compliance policy at runtime based on data classification schemes, attributes and roles.
* Advanced definition of policies for preventing data derivation based on classification (i.e. re-identification) – Prohibitions
* Column and Row level masking based on cell values and attibutes.
---++ Getting Started
* [[InstallationSteps][Install Steps]]
* [[QuickStart][Quick Start Guide]]
......
pom.xml
......@@ -24,7 +24,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>13</version>
<version>17</version>
</parent>
<modelVersion>4.0.0</modelVersion>
......@@ -355,6 +355,8 @@
<!-- skips checkstyle and find bugs -->
<skipCheck>false</skipCheck>
<skipTests>false</skipTests>
<skipDocs>true</skipDocs>
<skipSite>true</skipSite>
<projectBaseDir>${project.basedir}</projectBaseDir>
<titan.storage.backend>berkeleyje</titan.storage.backend>
<titan.index.backend>elasticsearch</titan.index.backend>
......@@ -390,7 +392,18 @@
</plugins>
</build>
</profile>
<profile>
<id>dist</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<properties>
<skipDocs>false</skipDocs>
</properties>
</profile>
</profiles>
<modules>
<module>common</module>
<module>typesystem</module>
......@@ -451,18 +464,6 @@
<url>http://repo.typesafe.com/typesafe/releases/</url>
</repository>
</repositories>
<distributionManagement>
<repository>
<id>${StagingId}</id>
<name>${StagingName}</name>
<url>${StagingUrl}</url>
</repository>
<snapshotRepository>
<id>${SnapshotsId}</id>
<name>${SnapshotsName}</name>
<url>${SnapshotsUrl}</url>
</snapshotRepository>
</distributionManagement>
<dependencyManagement>
<dependencies>
......@@ -1305,7 +1306,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.3</version>
<version>3.4</version>
</plugin>
<plugin>
......@@ -1360,6 +1361,8 @@
<scalaVersion>${scala.version}</scalaVersion>
<recompileMode>incremental</recompileMode>
<useZincServer>true</useZincServer>
<source>1.7</source>
<target>1.7</target>
<args>
<arg>-unchecked</arg>
<arg>-deprecation</arg>
......@@ -1643,6 +1646,40 @@
</filesets>
</configuration>
</plugin>
<plugin>
<artifactId>maven-site-plugin</artifactId>
<configuration>
<skip>${skipSite}</skip>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<skip>${skipDocs}</skip>
</configuration>
<executions>
<execution>
<id>javadoc</id>
<goals>
<goal>javadoc</goal>
</goals>
<phase>package</phase>
<configuration>
<aggregate>true</aggregate>
</configuration>
</execution>
<execution>
<id>aggregate</id>
<inherited>false</inherited>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
release-log.txt
......@@ -9,6 +9,7 @@ ATLAS-54 Rename configs in hive hook (shwethags)
ATLAS-3 Mixed Index creation fails with Date types (suma.shivaprasad via shwethags)
ALL CHANGES:
ATLAS-180 Cleanup atlas doc packaging (shwethags)
ATLAS-147 Fix a code issue when defineTypes (ltfxyz via shwethags)
ATLAS-110 UI: Lineage should be clickable (Vishal Kadam via Venkatesh Seetharam)
ATLAS-112 UI: Make lineage graph extensible for multiple nodes (Vishal Kadam via Venkatesh Seetharam)
......
webapp/pom.xml
......@@ -54,6 +54,7 @@
<goals>
<goal>docs</goal>
</goals>
<phase>site</phase>
</execution>
</executions>
<configuration>
......@@ -347,31 +348,11 @@
<artifactId>commons-io</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>uber-javadocs</id>
<phase>site</phase>
<goals>
<goal>javadoc</goal>
<goal>jar</goal>
</goals>
<configuration>
<includeTransitiveDependencySources>false</includeTransitiveDependencySources>
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<dependencySourceInclude>org.apache.atlas:*</dependencySourceInclude>
</dependencySourceIncludes>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<attachClasses>true</attachClasses>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment