You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@yetus.apache.org by aw...@apache.org on 2018/12/10 17:14:16 UTC
[3/3] yetus git commit: YETUS-729. in-progress docs post-mavenization
are broken
YETUS-729. in-progress docs post-mavenization are broken
Signed-off-by: Allen Wittenauer <aw...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/e94d8c4b
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/e94d8c4b
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/e94d8c4b
Branch: refs/heads/master
Commit: e94d8c4b34cc8eb50eea1e566ca2d14c09ac7dec
Parents: 5246a7f
Author: Allen Wittenauer <aw...@apache.org>
Authored: Fri Nov 30 18:25:26 2018 -0800
Committer: Allen Wittenauer <aw...@apache.org>
Committed: Mon Dec 10 09:11:28 2018 -0800
----------------------------------------------------------------------
asf-site-src/pom.xml | 66 ++++++++++++++------
.../source/documentation/in-progress.html.md | 6 +-
pom.xml | 4 +-
yetus-dist/src/main/assemblies/site.xml | 9 ++-
4 files changed, 61 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/yetus/blob/e94d8c4b/asf-site-src/pom.xml
----------------------------------------------------------------------
diff --git a/asf-site-src/pom.xml b/asf-site-src/pom.xml
index c60221b..2c0cfef 100644
--- a/asf-site-src/pom.xml
+++ b/asf-site-src/pom.xml
@@ -112,6 +112,8 @@
</configuration>
</execution>
<execution>
+ <!-- we create a symlink of current version->in-progress. This will cause
+ middle man to generate two copies of the output. -->
<id>in-progress</id>
<phase>pre-site</phase>
<goals>
@@ -233,25 +235,51 @@
<plugin>
<artifactId>maven-clean-plugin</artifactId>
- <configuration>
- <filesets>
- <fileset>
- <directory>source/documentation/</directory>
- <includes>
- <include>0*</include>
- </includes>
- <followSymlinks>false</followSymlinks>
- </fileset>
- <fileset>
- <directory>source/documentation/in-progress</directory>
- <includes>
- <include>CHANGELOG.md</include>
- <include>RELEASENOTES.md</include>
- </includes>
- <followSymlinks>false</followSymlinks>
- </fileset>
- </filesets>
- </configuration>
+ <executions>
+ <execution>
+ <id>bogus-site</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>clean</goal>
+ </goals>
+ <configuration>
+ <excludeDefaultDirectories>true</excludeDefaultDirectories>
+ <filesets>
+ <fileset>
+ <!-- middleman generated two copies, in-progess and the project version. Remove
+ the project version one. -->
+ <directory>${project.build.directory}/site/documentation/${project.version}</directory>
+ </fileset>
+ </filesets>
+ </configuration>
+ </execution>
+ <execution>
+ <id>releng</id>
+ <phase>clean</phase>
+ <goals>
+ <goal>clean</goal>
+ </goals>
+ <configuration>
+ <filesets>
+ <fileset>
+ <directory>source/documentation/</directory>
+ <includes>
+ <include>0*</include>
+ </includes>
+ <followSymlinks>false</followSymlinks>
+ </fileset>
+ <fileset>
+ <directory>source/documentation/in-progress</directory>
+ <includes>
+ <include>CHANGELOG.md</include>
+ <include>RELEASENOTES.md</include>
+ </includes>
+ <followSymlinks>false</followSymlinks>
+ </fileset>
+ </filesets>
+ </configuration>
+ </execution>
+ </executions>
</plugin>
<plugin>
http://git-wip-us.apache.org/repos/asf/yetus/blob/e94d8c4b/asf-site-src/source/documentation/in-progress.html.md
----------------------------------------------------------------------
diff --git a/asf-site-src/source/documentation/in-progress.html.md b/asf-site-src/source/documentation/in-progress.html.md
index a558efb..b980012 100644
--- a/asf-site-src/source/documentation/in-progress.html.md
+++ b/asf-site-src/source/documentation/in-progress.html.md
@@ -55,7 +55,9 @@ Options:
You can mark a file to be ignored by shelldocs by adding "SHELLDOC-IGNORE" as a comment in its own line.
-# Yetus Audience Annotations
+# Javadocs: Yetus Audience Annotations and more
Audience Annotations allows you to use Java Annotations to denote which parts of your Java library is publicly consumable and which parts are reserved for a more restricted use. It also provides doclets and examples for generating javadocs limited by audience.
-You can refer the user documentation [here](interface-classification) and the javadocs [here](audience-annotations-apidocs/).
+You can refer the user documentation [here](interface-classification).
+
+All javadocs (including audience annotations) are located [here](javadocs/).
http://git-wip-us.apache.org/repos/asf/yetus/blob/e94d8c4b/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 334c807..a0b4e03 100644
--- a/pom.xml
+++ b/pom.xml
@@ -279,8 +279,8 @@
<source>${maven.compile.source}</source>
<charset>${maven.compile.encoding}</charset>
<reportOutputDirectory>${project.build.directory}/site</reportOutputDirectory>
- <destDir>yetus-project/api</destDir>
- <doclet>org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet</doclet>
+ <destDir>documentation/in-progress/javadocs</destDir>
+ <doclet>org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>org.apache.yetus</groupId>
http://git-wip-us.apache.org/repos/asf/yetus/blob/e94d8c4b/yetus-dist/src/main/assemblies/site.xml
----------------------------------------------------------------------
diff --git a/yetus-dist/src/main/assemblies/site.xml b/yetus-dist/src/main/assemblies/site.xml
index d1c2db6..ad48163 100644
--- a/yetus-dist/src/main/assemblies/site.xml
+++ b/yetus-dist/src/main/assemblies/site.xml
@@ -35,7 +35,7 @@
</fileSet>
<fileSet>
<directory>${project.build.directory}/../../precommit/target/site</directory>
- <outputDirectory>documentation/in-progress/audience-annotations-apidocs</outputDirectory>
+ <outputDirectory>.</outputDirectory>
<includes>
<include>**</include>
</includes>
@@ -61,6 +61,13 @@
<include>**</include>
</includes>
</fileSet>
+ <fileSet>
+ <directory>${project.build.directory}/../../target/site</directory>
+ <outputDirectory>.</outputDirectory>
+ <includes>
+ <include>**</include>
+ </includes>
+ </fileSet>
<fileSet>
<directory>${project.build.directory}/../../asf-site-src/target/release/${project.version}</directory>
<outputDirectory>.</outputDirectory>