Skip to content

Commit a81c94c

Browse files
committed
Reorganize repository so additional modules can be added.
Closes #1503.
1 parent 80b3f81 commit a81c94c

File tree

450 files changed

+746
-490
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

450 files changed

+746
-490
lines changed

README.adoc

+107
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,113 @@ Building the documentation builds also the project without running tests.
177177
$ ./mvnw clean install -Pdistribute
178178
----
179179

180+
The generated documentation is available from `target/site/reference/html/index.html`.
181+
It can be staged and accessed via :
182+
183+
[source,bash]
184+
----
185+
docs=`pwd`/target/site/reference/html
186+
cd /tmp
187+
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
188+
git clone [email protected]:mikereiche/staged.git -b gh-pages
189+
cd staged
190+
cp -R $docs/* .
191+
git add .
192+
git commit --message "stage for review"
193+
git push origin gh-pages
194+
----
195+
https://mikereiche.github.io/staged/index.html
196+
197+
=== Building and staging reference documentation for review
198+
199+
[source,bash]
200+
----
201+
export MY_GIT_USER=<github-user>
202+
mvn generate-resources
203+
docs=`pwd`/target/site/reference/html
204+
pushd /tmp
205+
mkdir $$
206+
cd $$
207+
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
208+
# this examples uses a repository named "staged"
209+
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
210+
cd staged
211+
cp -R $docs/* .
212+
git add .
213+
git commit --message "stage for review"
214+
git push origin gh-pages
215+
popd
216+
----
217+
218+
The generated documentation is available from `target/site/reference/html/index.html`.
219+
220+
=== Building and staging reference documentation for review
221+
222+
[source,bash]
223+
----
224+
export MY_GIT_USER=<github-user>
225+
mvn generate-resources
226+
docs=`pwd`/target/site/reference/html
227+
pushd /tmp
228+
mkdir $$
229+
cd $$
230+
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
231+
# this examples uses a repository named "staged"
232+
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
233+
cd staged
234+
cp -R $docs/* .
235+
git add .
236+
git commit --message "stage for review"
237+
git push origin gh-pages
238+
popd
239+
----
240+
241+
The generated documentation is available from `target/site/reference/html/index.html`.
242+
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+
266+
=== Building and staging reference documentation for review
267+
268+
[source,bash]
269+
----
270+
export MY_GIT_USER=<github-user>
271+
mvn generate-resources
272+
docs=`pwd`/target/site/reference/html
273+
pushd /tmp
274+
mkdir $$
275+
cd $$
276+
# see https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
277+
# this examples uses a repository named "staged"
278+
git clone [email protected]:${MY_GIT_USER}/staged.git -b gh-pages
279+
cd staged
280+
cp -R $docs/* .
281+
git add .
282+
git commit --message "stage for review"
283+
git push origin gh-pages
284+
popd
285+
----
286+
180287
The generated documentation is available from `target/site/reference/html/index.html`.
181288

182289
== Examples

0 commit comments

Comments
 (0)