Skip to content
This repository was archived by the owner on Jun 29, 2018. It is now read-only.

Commit 54235c8

Browse files
joshistejoshiste
committed
Add asciidoc and remove the nested READMEs
1 parent a98973c commit 54235c8

File tree

7 files changed

+489
-272
lines changed

7 files changed

+489
-272
lines changed

‎README.md‎

Lines changed: 29 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -15,175 +15,86 @@ This application provides a simple GUI to administrate Spring Boot applications
1515
* Download main logfile
1616
* Show details, like
1717
* JVM & memory metrics
18-
* Counter & gauge Metrics
19-
* Datasource Metrics
18+
* Counter & gauge metrics
19+
* Datasource metrics
20+
* Cache metrics
2021
* View Java, system- & environment-properties
2122
* Support for Spring Clouds postable /env- &/refresh-endpoint
22-
* Easy loggerlevel management (for Logback)
23+
* Easy loglevel management (for Logback only)
2324
* Interact with JMX-beans
2425
* View threaddump
2526
* View traces
2627
* Mail and desktop notification on status change
2728
* Event journal of status changes (non persistent)
2829

29-
#### Server application
30-
Add the following dependency to your pom.xml.
31-
```xml
32-
<dependency>
33-
<groupId>de.codecentric</groupId>
34-
<artifactId>spring-boot-admin-server</artifactId>
35-
<version>1.3.0</version>
36-
</dependency>
37-
<dependency>
38-
<groupId>de.codecentric</groupId>
39-
<artifactId>spring-boot-admin-server-ui</artifactId>
40-
<version>1.3.0</version>
41-
</dependency>
42-
```
43-
44-
Create the Spring Boot Admin server with only one single annotation.
45-
```java
46-
@Configuration
47-
@EnableAutoConfiguration
48-
@EnableAdminServer
49-
public class Application {
50-
public static void main(String[] args) {
51-
SpringApplication.run(Application.class, args);
52-
}
53-
}
54-
```
55-
56-
See also the [example project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample) in this repository.
57-
58-
For configuring hazelcast support see [spring-boot-admin-server](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-server/README.md) or [hazelcast-example project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-hazelcast)
59-
60-
#### Register / discover client applications
61-
To get all your boot applications shown in spring boot admin you have two choices:
62-
63-
1) either you include the spring-boot-admin-starter-client into your applications
64-
65-
or
66-
67-
2) you add a DiscoveryClient (e.g. Eureka) to your spring boot admin server.
68-
69-
**Note:** If you don't include the spring-boot-admin-starter-client the logfile won't be available with spring boot 1.2.x, due to the fact that the logfile endpoint won't be exposed.
70-
71-
##### Register client applications via spring-boot-admin-starter-client
72-
Each application that want to register itself to the admin application has to include the [spring-boot-admin-starter-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client) as dependency. This starter JAR includes some [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot documentation") features that includes registering tasks, controller, etc.
73-
```xml
74-
<dependency>
75-
<groupId>de.codecentric</groupId>
76-
<artifactId>spring-boot-admin-starter-client</artifactId>
77-
<version>1.3.0</version>
78-
</dependency>
79-
```
80-
Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin server, e.g.
81-
```
82-
spring.boot.admin.url=http://localhost:8080
83-
```
84-
For all configuration options see [spring-boot-admin-starter-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client/README.md)
85-
86-
##### Discover client applications via DiscoveryClient
87-
Just add spring-clouds ``@EnableDiscoveryClient`` annotation and include an appropriate implementation (e.g. Eureka) to your classpath.
88-
```java
89-
@Configuration
90-
@EnableAutoConfiguration
91-
@EnableDiscoveryClient
92-
@EnableAdminServer
93-
public class SpringBootAdminApplication {
94-
public static void main(String[] args) {
95-
SpringApplication.run(SpringBootAdminApplication.class, args);
96-
}
97-
}
98-
```
99-
100-
```xml
101-
<dependency>
102-
<groupId>org.springframework.cloud</groupId>
103-
<artifactId>spring-cloud-starter-eureka</artifactId>
104-
<version>1.0.3.RELEASE</version>
105-
</dependency>
106-
```
107-
See the sample [discovery sample project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-discovery)
30+
## Getting Started
10831

109-
#### Mail notification on status change
32+
[A quick guide](http://codecentric.github.io/spring-boot-admin/1.3.0/#getting-started) to get started can be found in our docs.
11033

111-
Configure a JavaMailSender using spring-boot-starter-mail and set a recipient:
112-
```xml
113-
<dependency>
114-
<groupId>org.springframework.boot</groupId>
115-
<artifactId>spring-boot-starter-mail</artifactId>
116-
</dependency>
117-
```
118-
119-
```
120-
spring.mail.host=smtp.example.com
121-
[email protected]
122-
```
34+
## Reference Guide
12335

124-
For all configuration options see [spring-boot-admin-server](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-server/README.md)
125-
126-
### Snapshot builds
127-
You can access snapshot builds from the sonatype repository:
128-
```xml
129-
<snapshotRepository>
130-
<id>sonatype-nexus-snapshots</id>
131-
<name>Sonatype Nexus Snapshots</name>
132-
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
133-
</snapshotRepository>
134-
```
36+
[Version 1.3.0](http://codecentric.github.io/spring-boot-admin/1.3.0/)
13537

136-
#### Screenshots
38+
## Screenshots
13739

138-
##### Dashboard
40+
### Dashboard
13941

14042
[](url "title")
14143
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot.png">
14244

143-
##### Details
45+
### Details
14446

14547
[](url "title")
14648
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-details.png">
14749

148-
##### Environment
50+
### Environment
14951

15052
[](url "title")
15153
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-environment.png">
15254

153-
##### Logging
55+
### Logging
15456

15557
[](url "title")
15658
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-logging.png">
15759

158-
##### JMX
60+
### JMX
15961

16062
[](url "title")
16163
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-jmx.png">
16264

163-
##### Threads
65+
### Threads
16466

16567
[](url "title")
16668
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-threads.png">
16769

168-
##### Trace
70+
### Trace
16971

17072
[](url "title")
17173
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-trace.png">
17274

173-
##### Journal
75+
### Journal
17476

17577
[](url "title")
17678
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-journal.png">
17779

80+
## Snapshot builds
81+
You can access snapshot builds from the sonatype repository:
82+
```xml
83+
<snapshotRepository>
84+
<id>sonatype-nexus-snapshots</id>
85+
<name>Sonatype Nexus Snapshots</name>
86+
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
87+
</snapshotRepository>
88+
```
17889

179-
#### Build
90+
## Build
18091
In order to build spring-boot-admin you need to have node.js and npm on your `PATH`.
18192

18293
```shell
18394
mvn clean package
18495
```
18596

186-
#### Set version for next release
97+
## Set version for next release
18798
```shell
188-
mvn build-helper:parse-version versions:set versions:commit -DnewVersion=1.0.0-SNAPSHOT
99+
mvn versions:set versions:commit -DnewVersion=1.0.0-SNAPSHOT
189100
```

‎pom.xml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@
2222
<build-plugin.jacoco.version>0.7.5.201505241946</build-plugin.jacoco.version>
2323
<build-plugin.coveralls.version>4.0.0</build-plugin.coveralls.version>
2424
<build-plugin.gpg.version>1.6</build-plugin.gpg.version>
25+
<build-plugin.asciidoctor.version>1.5.2</build-plugin.asciidoctor.version>
2526
</properties>
2627
<modules>
2728
<module>spring-boot-admin-server</module>
2829
<module>spring-boot-admin-server-ui</module>
2930
<module>spring-boot-admin-samples</module>
3031
<module>spring-boot-admin-starter-client</module>
32+
<module>spring-boot-admin-docs</module>
3133
</modules>
3234
<organization>
3335
<name>codecentric AG</name>
@@ -94,6 +96,11 @@
9496
<artifactId>maven-gpg-plugin</artifactId>
9597
<version>${build-plugin.gpg.version}</version>
9698
</plugin>
99+
<plugin>
100+
<groupId>org.asciidoctor</groupId>
101+
<artifactId>asciidoctor-maven-plugin</artifactId>
102+
<version>${build-plugin.asciidoctor.version}</version>
103+
</plugin>
97104
</plugins>
98105
</pluginManagement>
99106
</build>

‎spring-boot-admin-docs/pom.xml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
<parent>
5+
<groupId>de.codecentric</groupId>
6+
<artifactId>spring-boot-admin</artifactId>
7+
<version>1.3.1-SNAPSHOT</version>
8+
<relativePath>..</relativePath>
9+
</parent>
10+
<groupId>de.codecentric</groupId>
11+
<artifactId>spring-boot-admin-docs</artifactId>
12+
<packaging>pom</packaging>
13+
<name>Spring Boot Admin Docs</name>
14+
<description>Spring Boot Admin Documentation</description>
15+
<url>https://github.com/codecentric/spring-boot-admin/</url>
16+
<build>
17+
<plugins>
18+
<plugin>
19+
<groupId>org.asciidoctor</groupId>
20+
<artifactId>asciidoctor-maven-plugin</artifactId>
21+
<executions>
22+
<execution>
23+
<id>output-html</id>
24+
<phase>generate-resources</phase>
25+
<goals>
26+
<goal>process-asciidoc</goal>
27+
</goals>
28+
<configuration>
29+
<sourceDocumentName>index.adoc</sourceDocumentName>
30+
<backend>html5</backend>
31+
<sourceHighlighter>coderay</sourceHighlighter>
32+
<attributes>
33+
<revnumber>${project.version}</revnumber>
34+
<projectversion>${project.version}</projectversion>
35+
</attributes>
36+
</configuration>
37+
</execution>
38+
</executions>
39+
</plugin>
40+
</plugins>
41+
</build>
42+
</project>

0 commit comments

Comments
 (0)