Add testapp and remove duplicate text from README. (#1518)
Closes #1517.
This commit is contained in:
107
README.adoc
107
README.adoc
@@ -177,113 +177,6 @@ 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 git@github.com: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 git@github.com:${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 git@github.com:${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 git@github.com:${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 git@github.com:${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
|
||||
|
||||
Reference in New Issue
Block a user