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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
107 changes: 107 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,113 @@ Building the documentation builds also the project without running tests.
$ ./mvnw clean install -Pdistribute
----

The generated documentation is available from `target/site/reference/html/index.html`.
It can be staged and accessed via :

[source,bash]
----
docs=`pwd`/target/site/reference/html
cd /tmp
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
git clone [email protected]:mikereiche/staged.git -b gh-pages
cd staged
cp -R $docs/* .
git add .
git commit --message "stage for review"
git push origin gh-pages
----
https://mikereiche.github.io/staged/index.html

=== Building and staging reference documentation for review

[source,bash]
----
export MY_GIT_USER=<github-user>
mvn generate-resources
docs=`pwd`/target/site/reference/html
pushd /tmp
mkdir $$
cd $$
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
# this examples uses a repository named "staged"
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
cd staged
cp -R $docs/* .
git add .
git commit --message "stage for review"
git push origin gh-pages
popd
----

The generated documentation is available from `target/site/reference/html/index.html`.

=== Building and staging reference documentation for review

[source,bash]
----
export MY_GIT_USER=<github-user>
mvn generate-resources
docs=`pwd`/target/site/reference/html
pushd /tmp
mkdir $$
cd $$
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
# this examples uses a repository named "staged"
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
cd staged
cp -R $docs/* .
git add .
git commit --message "stage for review"
git push origin gh-pages
popd
----

The generated documentation is available from `target/site/reference/html/index.html`.

=== Building and staging reference documentation for review

[source,bash]
----
export MY_GIT_USER=<github-user>
mvn generate-resources
docs=`pwd`/target/site/reference/html
pushd /tmp
mkdir $$
cd $$
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
# this examples uses a repository named "staged"
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
cd staged
cp -R $docs/* .
git add .
git commit --message "stage for review"
git push origin gh-pages
popd
----

The generated documentation is available from `target/site/reference/html/index.html`.

=== Building and staging reference documentation for review

[source,bash]
----
export MY_GIT_USER=<github-user>
mvn generate-resources
docs=`pwd`/target/site/reference/html
pushd /tmp
mkdir $$
cd $$
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
# this examples uses a repository named "staged"
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
cd staged
cp -R $docs/* .
git add .
git commit --message "stage for review"
git push origin gh-pages
popd
----

The generated documentation is available from `target/site/reference/html/index.html`.

=== Building and staging reference documentation for review
Expand Down
Loading