Skip to content

Commit 96dcc60

Browse files
rhusarrhusar
authored
Merge pull request #228 from rhusar/maven-wrapper
Cleanup readme file
2 parents a3dd5c0 + bc8fb1a commit 96dcc60

2 files changed

Lines changed: 12 additions & 99 deletions

File tree

‎.gitattributes‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
* text=auto
1+
* text=auto
2+
*.cmd text eol=crlf

‎README.adoc‎

Lines changed: 10 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -23,108 +23,20 @@ How can I contribute?
2323
* Use shorter lines to make rebasing and editing from the web slightly easier, ideally a single sentence per line.
2424
* Documentation always resides in `main` branch of the upstream (`modcluster/docs.modcluster.io`) repository.
2525

26+
== Issues
27+
28+
Issues can be reported using GitHub Issues:
29+
30+
https://github.com/modcluster/docs.modcluster.io/issues
31+
2632
== Building
2733

28-
The build uses Apache Maven.
34+
Building locally requires JDK 11 or newer installed.
35+
The build uses Apache Maven and provides Maven wrapper for ease of use:
2936

30-
[source]
37+
[source,shell]
3138
----
32-
[rhusar@ribera docs.modcluster.io]$ mvn verify
33-
[INFO] Scanning for projects...
34-
[INFO] ------------------------------------------------------------------------
35-
[INFO] Reactor Build Order:
36-
[INFO]
37-
[INFO] mod_cluster docs (parent) [pom]
38-
[INFO] mod_cluster docs: Documentation [pom]
39-
[INFO]
40-
[INFO] -----------< org.jboss.mod_cluster:mod_cluster-docs-parent >------------
41-
[INFO] Building mod_cluster docs (parent) 2.0.0.Final-SNAPSHOT [1/2]
42-
[INFO] from pom.xml
43-
[INFO] --------------------------------[ pom ]---------------------------------
44-
[INFO]
45-
[INFO] --- enforcer:3.4.1:enforce (enforce-java-version) @ mod_cluster-docs-parent ---
46-
[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed
47-
[INFO] Rule 1: org.apache.maven.enforcer.rules.version.RequireJavaVersion passed
48-
[INFO]
49-
[INFO] --- enforcer:3.4.1:enforce (enforce-maven-version) @ mod_cluster-docs-parent ---
50-
[INFO] Rule 0: org.apache.maven.enforcer.rules.version.RequireMavenVersion passed
51-
[INFO]
52-
[INFO] --- enforcer:3.4.1:enforce (enforce-https-repositories) @ mod_cluster-docs-parent ---
53-
[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed
54-
[INFO]
55-
[INFO] --- buildnumber:3.2.0:create (get-scm-revision) @ mod_cluster-docs-parent ---
56-
[INFO] Executing: /bin/sh -c cd '/Users/rhusar/git/docs.modcluster.io' && 'git' 'rev-parse' '--verify' 'HEAD'
57-
[INFO] Working directory: /Users/rhusar/git/docs.modcluster.io
58-
[INFO] Storing buildNumber: 9917545bbd99d1c3457f5ede71cb4f42c8090405 at timestamp: 1708340454545
59-
[INFO] Executing: /bin/sh -c cd '/Users/rhusar/git/docs.modcluster.io' && 'git' 'symbolic-ref' 'HEAD'
60-
[INFO] Working directory: /Users/rhusar/git/docs.modcluster.io
61-
[INFO] Storing scmBranch: main
62-
[INFO]
63-
[INFO] --- source:3.2.1:jar-no-fork (attach-sources) @ mod_cluster-docs-parent ---
64-
[INFO]
65-
[INFO] ---------------< org.jboss.mod_cluster:mod_cluster-docs >---------------
66-
[INFO] Building mod_cluster docs: Documentation 2.0.0.Final-SNAPSHOT [2/2]
67-
[INFO] from docs/pom.xml
68-
[INFO] --------------------------------[ pom ]---------------------------------
69-
[INFO]
70-
[INFO] --- enforcer:3.4.1:enforce (enforce-java-version) @ mod_cluster-docs ---
71-
[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed
72-
[INFO]
73-
[INFO] --- enforcer:3.4.1:enforce (enforce-maven-version) @ mod_cluster-docs ---
74-
[INFO]
75-
[INFO] --- enforcer:3.4.1:enforce (enforce-https-repositories) @ mod_cluster-docs ---
76-
[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed
77-
[INFO]
78-
[INFO] --- buildnumber:3.2.0:create (get-scm-revision) @ mod_cluster-docs ---
79-
[INFO]
80-
[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-pdf-user-guide) @ mod_cluster-docs ---
81-
[INFO] Copying 6 resources to images
82-
uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/properties.rb:54: warning: `*' interpreted as argument prefix
83-
uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/ttf.rb:40: warning: assigned but unused variable - platform_specific_id
84-
uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/ttf.rb:35: warning: assigned but unused variable - format
85-
uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/ostruct.rb:466: warning: OpenStruct#public_send accesses caller method's state and should not be aliased
86-
uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/ostruct.rb:466: warning: OpenStruct#method accesses caller method's state and should not be aliased
87-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/index.adoc
88-
[INFO]
89-
[INFO] --- source:3.2.1:jar-no-fork (attach-sources) @ mod_cluster-docs ---
90-
[INFO]
91-
[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-html-user-guide) @ mod_cluster-docs ---
92-
[INFO] Copying 6 resources to images
93-
[INFO] Copying 1524 resources to .
94-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/index.adoc
95-
[INFO]
96-
[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-html-developer-resources) @ mod_cluster-docs ---
97-
[INFO] Copying 5 resources to images
98-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/q_a_webinar.adoc
99-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/encrypting_connection.adoc
100-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/node_conf.adoc
101-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/ping_pong.adoc
102-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/cluster_listener.adoc
103-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/jbc_data_partitioning.adoc
104-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/management_protocol.adoc
105-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/reverse_extension.adoc
106-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/hw_load_balancer.adoc
107-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/version_1.3.1.adoc
108-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/internals.adoc
109-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/fedora24_25_update_testing.adoc
110-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/info_rsp.adoc
111-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/mod_proxy_forwarding.adoc
112-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/index.adoc
113-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/design.adoc
114-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/node_balancers.adoc
115-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/choosing_doc_platform.adoc
116-
[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/as_integration.adoc
117-
[INFO] ------------------------------------------------------------------------
118-
[INFO] Reactor Summary for mod_cluster docs (parent) 2.0.0.Final-SNAPSHOT:
119-
[INFO]
120-
[INFO] mod_cluster docs (parent) .......................... SUCCESS [ 0.901 s]
121-
[INFO] mod_cluster docs: Documentation .................... SUCCESS [ 30.077 s]
122-
[INFO] ------------------------------------------------------------------------
123-
[INFO] BUILD SUCCESS
124-
[INFO] ------------------------------------------------------------------------
125-
[INFO] Total time: 31.114 s
126-
[INFO] Finished at: 2024-02-19T12:01:24+01:00
127-
[INFO] ------------------------------------------------------------------------
39+
./mvnw verify
12840
----
12941

13042
Resulting files are located in the `docs/target/generated-docs/` directory.

0 commit comments

Comments
 (0)