Skip to content

Add testapp and remove duplicate text from README. #1518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2022
Merged

Add testapp and remove duplicate text from README. #1518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
107 changes: 0 additions & 107 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions spring-data-testapp/HELP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Getting Started

### Reference Documentation
For further reference, please consider the following sections:

* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/2.5.2/maven-plugin/reference/html/)
* [Create an OCI image](https://docs.spring.io/spring-boot/docs/2.5.2/maven-plugin/reference/html/#build-image)
* [Spring Data Couchbase](https://docs.spring.io/spring-boot/docs/2.5.2/reference/htmlsingle/#boot-features-couchbase)

Loading