From bdba49e06c645ea76ecaff7cf7badafe74adbb59 Mon Sep 17 00:00:00 2001 From: Radoslav Husar Date: Fri, 25 Oct 2024 09:38:46 +0200 Subject: [PATCH 1/2] Fix maven wrapper script line endings on Windows. --- .gitattributes | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitattributes b/.gitattributes index 176a458f..c2120c11 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,2 @@ -* text=auto +* text=auto +*.cmd text eol=crlf From bc8fb1a886c6dcba492a2d3c7012270c40c87d44 Mon Sep 17 00:00:00 2001 From: Radoslav Husar Date: Fri, 25 Oct 2024 09:46:35 +0200 Subject: [PATCH 2/2] Cleanup readme file. --- README.adoc | 108 +++++----------------------------------------------- 1 file changed, 10 insertions(+), 98 deletions(-) diff --git a/README.adoc b/README.adoc index 4c3fdd3e..48719476 100644 --- a/README.adoc +++ b/README.adoc @@ -23,108 +23,20 @@ How can I contribute? * Use shorter lines to make rebasing and editing from the web slightly easier, ideally a single sentence per line. * Documentation always resides in `main` branch of the upstream (`modcluster/docs.modcluster.io`) repository. +== Issues + +Issues can be reported using GitHub Issues: + +https://github.com/modcluster/docs.modcluster.io/issues + == Building -The build uses Apache Maven. +Building locally requires JDK 11 or newer installed. +The build uses Apache Maven and provides Maven wrapper for ease of use: -[source] +[source,shell] ---- -[rhusar@ribera docs.modcluster.io]$ mvn verify -[INFO] Scanning for projects... -[INFO] ------------------------------------------------------------------------ -[INFO] Reactor Build Order: -[INFO] -[INFO] mod_cluster docs (parent) [pom] -[INFO] mod_cluster docs: Documentation [pom] -[INFO] -[INFO] -----------< org.jboss.mod_cluster:mod_cluster-docs-parent >------------ -[INFO] Building mod_cluster docs (parent) 2.0.0.Final-SNAPSHOT [1/2] -[INFO] from pom.xml -[INFO] --------------------------------[ pom ]--------------------------------- -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-java-version) @ mod_cluster-docs-parent --- -[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed -[INFO] Rule 1: org.apache.maven.enforcer.rules.version.RequireJavaVersion passed -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-maven-version) @ mod_cluster-docs-parent --- -[INFO] Rule 0: org.apache.maven.enforcer.rules.version.RequireMavenVersion passed -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-https-repositories) @ mod_cluster-docs-parent --- -[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed -[INFO] -[INFO] --- buildnumber:3.2.0:create (get-scm-revision) @ mod_cluster-docs-parent --- -[INFO] Executing: /bin/sh -c cd '/Users/rhusar/git/docs.modcluster.io' && 'git' 'rev-parse' '--verify' 'HEAD' -[INFO] Working directory: /Users/rhusar/git/docs.modcluster.io -[INFO] Storing buildNumber: 9917545bbd99d1c3457f5ede71cb4f42c8090405 at timestamp: 1708340454545 -[INFO] Executing: /bin/sh -c cd '/Users/rhusar/git/docs.modcluster.io' && 'git' 'symbolic-ref' 'HEAD' -[INFO] Working directory: /Users/rhusar/git/docs.modcluster.io -[INFO] Storing scmBranch: main -[INFO] -[INFO] --- source:3.2.1:jar-no-fork (attach-sources) @ mod_cluster-docs-parent --- -[INFO] -[INFO] ---------------< org.jboss.mod_cluster:mod_cluster-docs >--------------- -[INFO] Building mod_cluster docs: Documentation 2.0.0.Final-SNAPSHOT [2/2] -[INFO] from docs/pom.xml -[INFO] --------------------------------[ pom ]--------------------------------- -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-java-version) @ mod_cluster-docs --- -[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-maven-version) @ mod_cluster-docs --- -[INFO] -[INFO] --- enforcer:3.4.1:enforce (enforce-https-repositories) @ mod_cluster-docs --- -[INFO] Rule 0: org.apache.maven.enforcer.rules.BannedRepositories passed -[INFO] -[INFO] --- buildnumber:3.2.0:create (get-scm-revision) @ mod_cluster-docs --- -[INFO] -[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-pdf-user-guide) @ mod_cluster-docs --- -[INFO] Copying 6 resources to images -uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/properties.rb:54: warning: `*' interpreted as argument prefix -uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/ttf.rb:40: warning: assigned but unused variable - platform_specific_id -uri:classloader:/gems/prawn-svg-0.33.0/lib/prawn/svg/ttf.rb:35: warning: assigned but unused variable - format -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 -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 -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/index.adoc -[INFO] -[INFO] --- source:3.2.1:jar-no-fork (attach-sources) @ mod_cluster-docs --- -[INFO] -[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-html-user-guide) @ mod_cluster-docs --- -[INFO] Copying 6 resources to images -[INFO] Copying 1524 resources to . -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/index.adoc -[INFO] -[INFO] --- asciidoctor:2.2.6:process-asciidoc (output-html-developer-resources) @ mod_cluster-docs --- -[INFO] Copying 5 resources to images -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/q_a_webinar.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/encrypting_connection.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/node_conf.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/ping_pong.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/cluster_listener.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/jbc_data_partitioning.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/management_protocol.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/reverse_extension.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/hw_load_balancer.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/version_1.3.1.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/internals.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/fedora24_25_update_testing.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/info_rsp.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/mod_proxy_forwarding.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/index.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/design.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/node_balancers.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/choosing_doc_platform.adoc -[INFO] Converted /Users/rhusar/git/docs.modcluster.io/docs/src/main/asciidoc/developer/as_integration.adoc -[INFO] ------------------------------------------------------------------------ -[INFO] Reactor Summary for mod_cluster docs (parent) 2.0.0.Final-SNAPSHOT: -[INFO] -[INFO] mod_cluster docs (parent) .......................... SUCCESS [ 0.901 s] -[INFO] mod_cluster docs: Documentation .................... SUCCESS [ 30.077 s] -[INFO] ------------------------------------------------------------------------ -[INFO] BUILD SUCCESS -[INFO] ------------------------------------------------------------------------ -[INFO] Total time: 31.114 s -[INFO] Finished at: 2024-02-19T12:01:24+01:00 -[INFO] ------------------------------------------------------------------------ +./mvnw verify ---- Resulting files are located in the `docs/target/generated-docs/` directory.