Skip to content

Commit 57e660e

Browse files
committed
Rebase/merge main.
1 parent 8d54b12 commit 57e660e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,29 @@ The generated documentation is available from `target/site/reference/html/index.
240240

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

243+
=== Building and staging reference documentation for review
244+
245+
[source,bash]
246+
----
247+
export MY_GIT_USER=<github-user>
248+
mvn generate-resources
249+
docs=`pwd`/target/site/reference/html
250+
pushd /tmp
251+
mkdir $$
252+
cd $$
253+
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
254+
# this examples uses a repository named "staged"
255+
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
256+
cd staged
257+
cp -R $docs/* .
258+
git add .
259+
git commit --message "stage for review"
260+
git push origin gh-pages
261+
popd
262+
----
263+
264+
The generated documentation is available from `target/site/reference/html/index.html`.
265+
243266
== Examples
244267

245268
* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.

0 commit comments

Comments
 (0)