Skip to content

Commit

Permalink
docs: new documentation page
Browse files Browse the repository at this point in the history
  • Loading branch information
@SteKoe
SteKoe committed Dec 6, 2024
1 parent 18318d2 commit cf8c085
Show file tree
Hide file tree
Showing 85 changed files with 21,779 additions and 2,189 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ root = true
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.java]
indent_style = tab
indent_size = 4
Expand Down
3 changes: 1 addition & 2 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@
<checkstyle.version>10.20.2</checkstyle.version>
<spring-javaformat-checkstyle.version>0.0.43</spring-javaformat-checkstyle.version>
<nexus-staging-maven-plugin.version>1.7.0</nexus-staging-maven-plugin.version>
<node.version>v18.20.2</node.version>
<npm.version>10.5.2</npm.version>
<node.version>v22.12.0</node.version>
<jolokia-support-spring.version>2.1.2</jolokia-support-spring.version>
</properties>
<modules>
Expand Down
115 changes: 56 additions & 59 deletions spring-boot-admin-docs/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
~ limitations under the License.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-boot-admin-docs</artifactId>
Expand All @@ -29,77 +29,74 @@
<relativePath>../spring-boot-admin-build</relativePath>
</parent>

<properties>
<site.skin.version>2.3.3</site.skin.version>
</properties>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<!--
Due to changes in Doxia (see https://cwiki.apache.org/confluence/display/MAVEN/Towards+Doxia+2.0.0+Stack),
we have to use a fixed version here, as our site skin does not work with the latest version.
-->
<version>3.12.1</version>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<configuration>
<workingDirectory>src/site</workingDirectory>
<environmentVariables>
<NODE_ENV>production</NODE_ENV>
<VERSION>${project.version}</VERSION>
</environmentVariables>
</configuration>
<executions>
<execution>
<id>output-html</id>
<phase>generate-resources</phase>
<id>install-node-and-npm</id>
<goals>
<goal>install-node-and-npm</goal>
</goals>
<configuration>
<nodeVersion>${node.version}</nodeVersion>
</configuration>
</execution>
<execution>
<id>npm-install</id>
<phase>compile</phase>
<goals>
<goal>npm</goal>
</goals>
<configuration>
<arguments>ci --prefer-offline --no-audit</arguments>
</configuration>
</execution>
<execution>
<id>npm-build</id>
<phase>prepare-package</phase>
<goals>
<goal>site</goal>
<goal>npm</goal>
</goals>
<configuration>
<outputDirectory>target/generated-docs</outputDirectory>
<arguments>run build:prod</arguments>
</configuration>
</execution>
</executions>
<configuration>
<!-- Disable generateReports if you don't want to include the built-in reports -->
<generateReports>false</generateReports>
<generateSitemap>false</generateSitemap>
<relativizeDecorationLinks>false</relativizeDecorationLinks>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
<asciidoc>
<!-- Optional site-wide AsciiDoc attributes -->
<attributes>
<icons>font</icons>
<source-highlighter>coderay</source-highlighter>
<commit-id>${git.commit.id.abbrev}</commit-id>
<commit-time>${git.commit.time}</commit-time>
<project-version>${project.version}</project-version>
<spring-cloud-version>${spring-cloud.version}</spring-cloud-version>
<samples-dir>${basedir}/../spring-boot-admin-samples/</samples-dir>
<main-dir>${basedir}/../</main-dir>
<github-src>https://github.com/codecentric/spring-boot-admin/tree/master</github-src>
</attributes>
</asciidoc>
</configuration>
<dependencies>
<dependency>
<groupId>com.bernardomg.maven.skins</groupId>
<artifactId>docs-maven-skin</artifactId>
<version>${site.skin.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-converter-doxia-module</artifactId>
<version>${asciidoctor-converter-doxia-module.version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.8.0</version>
<groupId>org.rodnansol</groupId>
<artifactId>spring-configuration-property-documenter-maven-plugin</artifactId>
<version>0.6.1</version>
<executions>
<execution>
<id>generate-adoc</id>
<goals>
<goal>generate-and-aggregate-documents</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<type>ADOC</type>
<inputs>
<input>
<name>spring-boot-admin-server</name>
<input>../spring-boot-admin-server</input>
</input>
</inputs>
<outputFile>target/aggregated-adoc.adoc</outputFile>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</reporting>
</build>
</project>
18 changes: 18 additions & 0 deletions spring-boot-admin-docs/src/site/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
25 changes: 25 additions & 0 deletions spring-boot-admin-docs/src/site/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ npm install
```

### Local Development

```
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
37 changes: 0 additions & 37 deletions spring-boot-admin-docs/src/site/asciidoc/_server-clustering.adoc
View file

This file was deleted.

141 changes: 0 additions & 141 deletions spring-boot-admin-docs/src/site/asciidoc/_server-discovery.adoc
View file

This file was deleted.

Loading

0 comments on commit cf8c085

Please sign in to comment.