Author: gk
Date: Thu Apr 12 13:18:14 2018
New Revision: 1828975
URL: http://svn.apache.org/viewvc?rev=1828975&view=rev
Log:
- Move READMEs
Added:
turbine/fulcrum/trunk/README_MORE_WEBSITE_MULTI_MODULES
Removed:
turbine/fulcrum/trunk/security/README
Modified:
turbine/fulcrum/trunk/README.txt
turbine/fulcrum/trunk/security/dist/src/assembly/src.xml
Modified: turbine/fulcrum/trunk/README.txt
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/README.txt?rev=1828975&r1=1828974&r2=1828975&view=diff
==============================================================================
--- turbine/fulcrum/trunk/README.txt (original)
+++ turbine/fulcrum/trunk/README.txt Thu Apr 12 13:18:14 2018
@@ -1,4 +1,22 @@
--------------------------------------------------------------------------
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+--------------------------------------------------------------------------
+
F U L C R U M
--------------------------------------------------------------------------
@@ -18,6 +36,14 @@ instructions on building. This document
https://maven.apache.org/guides/getting-started/
+-------------------------------------------
+GIT READONLY
+-------------------------------------------
+
+You could use git to checkout current trunk:
+
+git clone https://github.com/apache/turbine-fulcrum.git
+git checkout -b remote-trunk remotes/origin/trunk
--------------------------------------------------------------------------
COMPONENT DEVELOPMENT
@@ -93,6 +119,9 @@ Steps
// - SVN checkout released source from
https://svn.apache.org/repos/asf/turbine/<..>/tags/<..>
// - Generate artifacts (check local repo and target for artifacts) from
released version:
mvn clean install package -Papache-release -DcreateChecksum=true
+ // generate checksums in dist source/binaries folde. More information here:
https://checker.apache.org/doc/README.html and
+ // https://checker.apache.org/dist/verify.html
+
// If not all jars are included (assembly plugin _SHOULD_ run after jar
generation), run a second time without clean
// If no md5 files are in the target folder, check local repo
Added: turbine/fulcrum/trunk/README_MORE_WEBSITE_MULTI_MODULES
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/README_MORE_WEBSITE_MULTI_MODULES?rev=1828975&view=auto
==============================================================================
--- turbine/fulcrum/trunk/README_MORE_WEBSITE_MULTI_MODULES (added)
+++ turbine/fulcrum/trunk/README_MORE_WEBSITE_MULTI_MODULES Thu Apr 12 13:18:14
2018
@@ -0,0 +1,39 @@
+$Id$
+
+The Fulcrum Website Instructions for Multi Modules
+--------------------------------
+
+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 and turbine-parent plugin check the following list items:
+
+* Verify turbine.site.path is matching pubScmUrl property of goal
scm-publish:publish-scm (e.g. by investigating the result of mvn
help:effective-pom)
+
+* Verify turbine.scmPubCheckoutDirectory is matching property
checkoutDirectory of goal scm-publish:publish-scm.
+
+* Once you have the site checked out locally, as it is multi-module project
(with submodules) execute first
+
+ mvn clean install
+
+* then
+
+ mvn site site:stage
+
+This will build the documentation into the target/site/, resp. target/staging/
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 added, deleted or updated run:
+
+ mvn site site:stage scm-publish:publish-scm -Dscmpublish.dryRun=true
+
+This will generate the site into turbine.site.cache folder
(target/turbine-sites by default) and print any changes to STDOUT.
+
+* To deploy run the same command (adding -Dusername=<username>
-Dpassword=<pw>) remove the argument scmpublish.dryRun or set it to false.
Check if tryUpdate is set to false to get a clean working copy again).
Alternatively, if you have set scmpublish.skipCheckin=true in the previous
step, you have to do a manual commit.
+
+
Modified: turbine/fulcrum/trunk/security/dist/src/assembly/src.xml
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/security/dist/src/assembly/src.xml?rev=1828975&r1=1828974&r2=1828975&view=diff
==============================================================================
Binary files - no diff available.
