Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@
/*.iws
!/.idea/checkstyle-idea.xml
!/.idea/externalDependencies.xml
node_modules/
target/
Binary file added .mvn/wrapper/maven-wrapper.jar
Binary file not shown.
2 changes: 2 additions & 0 deletions .mvn/wrapper/maven-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.8.9/apache-maven-3.8.9-bin.zip

20 changes: 17 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,32 @@ This README covers how to build the docs in a software branch as well as how to

== Building the Site

You can build the entire site by invoking the following and then viewing the site at `build/site/index.html`
To build the entire site invoke the following command:

[source,bash]
----
./gradlew antora
./mvnw antora
----

You will then be able to view the site at `target/site/index.html`

== Building a Specific Branch

You can build a specific branch and then viewing the branch specific site at `build/site/index.html`.

[source,bash]
----
./gradlew antora
export BUILD_VERSION=4.0.0-SNAPSHOT
export BUILD_REFNAME=main
./mvnw antora
----

You will then be able to see the site at `build/site/`

[NOTE]
====
If you get the following error, then you must first build the full site and publish it so that a partial builds are supported.
----
FATAL (antora): https://docs.spring.io/spring-shell/reference/site-manifest.json returned response code 404 (Not Found)
----
====
2 changes: 1 addition & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ git:
ensure_git_suffix: false
content:
sources:
- url: https://github.com/spring-projects/spring-shell
- url: .
# Refname matching:
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
branches: [ main,'({3..9}).+({0..9}).x', '!(3.0.x)', '!(3.1.x)' ]
Expand Down
18 changes: 0 additions & 18 deletions build.gradle

This file was deleted.

2 changes: 0 additions & 2 deletions gradle.properties

This file was deleted.

240 changes: 0 additions & 240 deletions gradlew

This file was deleted.

Loading