SpringCloud/spring-cloud-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Migrates documentation to Antora (#241)

Browse Source 
* Migrate Structure

* Insert explicit ids for headers

* Copy default antora files

* Fix indentation for all pages

* Generate a default navigation

* Remove includes

* Enable Section Summary TOC for small pages

* WIP

* Updated the docs

* Removed unnecessary file deployment step

* Left deploy goal only

* Fixed configprops location

* Fixed gitignores and path of configprops generation

* Upgraded ui bundle

* Removed node files

* Removed unnecessary docs zip uploading
This commit is contained in:
Marcin Grzejszczak
2023-09-08 13:00:27 +02:00
committed by GitHub
parent 573ef75c97
commit 2282c2400a
26 changed files with 241 additions and 974 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/pom.xml
View File

@@ -19,7 +19,6 @@
<maven-dependency-plugin-for-docs.phase>none</maven-dependency-plugin-for-docs.phase>
<maven-dependency-plugin-for-docs-classes.phase>none</maven-dependency-plugin-for-docs-classes.phase>
<docs.resources.dir>${project.basedir}/src/main/</docs.resources.dir>
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
<!-- Don't upload docs jar to central / repo.spring.io -->
<!-- TODO: temporary, don't want it to central? -->
<maven-deploy-plugin-default.phase>deploy</maven-deploy-plugin-default.phase>
@@ -59,14 +58,6 @@
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main</directory>
<excludes>
<exclude>java/**/*.*</exclude>
</excludes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -97,6 +88,12 @@
<profile>
<id>docs</id>
<build>
<resources>
<resource>
<directory>src/main/antora/resources/antora-resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>pl.project13.maven</groupId>
@@ -106,17 +103,25 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-component-version-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
<executions>
<execution>
<phase>prepare-package</phase>
<goals>
<goal>antora</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -124,10 +129,6 @@
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<goals>
<goal>deploy</goal>
<goal>deploy-file</goal>
</goals>
</plugin>
</plugins>
</build>