You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@turbine.apache.org by gk...@apache.org on 2021/09/15 13:13:19 UTC
[turbine-fulcrum-site] 28/31: - update most Fulcrum parent to
version 8 and update Fulcrum site + use md format for README
This is an automated email from the ASF dual-hosted git repository.
gk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/turbine-fulcrum-site.git
commit 666d48dbf0a43e8c676996e08dc72fde2133525e
Author: Georg Kallidis <gk...@apache.org>
AuthorDate: Wed Apr 28 10:31:09 2021 +0000
- update most Fulcrum parent to version 8 and update Fulcrum site + use md format for README
git-svn-id: https://svn.apache.org/repos/asf/turbine/fulcrum/trunk/site@1889262 13f79535-47bb-0310-9956-ffa450edef68
---
README.txt => README.md | 82 +++++++++++++++++++++++++++----------------------
pom.xml | 13 ++++----
2 files changed, 53 insertions(+), 42 deletions(-)
diff --git a/README.txt b/README.md
similarity index 68%
rename from README.txt
rename to README.md
index 5b2b11f..389e9df 100644
--- a/README.txt
+++ b/README.md
@@ -1,36 +1,46 @@
-$Id$
-
-The Fulcrum Website Instructions
---------------------------------
-
-The Fulcrum web site is based on .xml files which are transformed
-into .html files using Maven.
-
-<http://maven.apache.org/>
-
-Using scm-publish Plugin, cft. http://commons.apache.org/site-publish.html for publishing:
-
-Check first, that turbine.site.path matches the target pubScmUrl (e.g. by investigating the result of mvn help:effective-pom)
-
-Once you have the site checked out locally, cd into your fulcrum-site directory and execute:
-
-mvn site
-
-This will build the documentation into the target/site/ directory. The output will show you which files got re-generated.
-
-If you would like to make modifications to the web site documents, you simply need to edit the files in the xdocs/ directory.
-
-Once you have built your documentation and confirmed that your changes are ok, you can check your .xml files back into Subversion.
-
-To test what files would be deleted or updated run:
-
-mvn site:stage scm-publish:publish-scm -Dscmpublish.dryRun=true
-
-To deploy the site execute:
-
-mvn site:stage scm-publish:publish-scm
-
-To do this you need an account on the people.apache.org machine!!
-
-
-
+
+# The Fulcrum Website Instructions
+--------------------------------
+
+The Fulcrum web site is based on .xml files which are transformed
+into .html files using Maven.
+
+<http://maven.apache.org/>
+
+## Description
+
+The Fulcrum site builds the wrapper site for the Fulcrum components listed in site.xml.
+
+### Publishing
+
+Using scm-publish Plugin, cft. https://commons.apache.org/site-publish.html for publishing:
+
+Check first, that turbine.site.path matches the target pubScmUrl (e.g. by investigating the result of mvn help:effective-pom)
+
+Once you have the site checked out locally, cd into your fulcrum-site directory and execute:
+
+
+ mvn site
+
+
+This will build the documentation into the target/site/ directory. The output will show you which files got re-generated.
+
+If you would like to make modifications to the web site documents, you simply need to edit the files in the xdocs/ directory.
+
+Once you have built your documentation and confirmed that your changes are ok, you can check your .xml files back into Subversion.
+
+To test what files would be deleted or updated run:
+
+
+ mvn site:stage scm-publish:publish-scm -Dscmpublish.dryRun=true
+
+
+To deploy the site execute:
+
+ mvn site:stage scm-publish:publish-scm
+
+
+To do this you need an account on the people.apache.org machine!!
+
+
+
diff --git a/pom.xml b/pom.xml
index 81d9f63..43d4059 100644
--- a/pom.xml
+++ b/pom.xml
@@ -23,7 +23,7 @@
<parent>
<artifactId>turbine-parent</artifactId>
<groupId>org.apache.turbine</groupId>
- <version>7</version>
+ <version>8</version>
</parent>
<groupId>org.apache.fulcrum</groupId>
@@ -282,15 +282,16 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.0.1</version>
+ <version>3.1.1</version>
<reportSets>
<reportSet>
<reports>
+ <!-- no dependencies and no ci-management -->
<report>summary</report>
- <report>project-team</report>
- <report>mailing-list</report>
- <report>issue-tracking</report>
- <report>license</report>
+ <report>team</report>
+ <report>mailing-lists</report>
+ <report>issue-management</report>
+ <report>licenses</report>
<report>scm</report>
</reports>
</reportSet>