[maven-scm-publish-plugin] branch master updated: improved documentation

[hb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scm-publish-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 741c2d7  improved documentation
741c2d7 is described below

commit 741c2d79eebb30c23d9049699bb5ea0164d3e3d4
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Thu Jan 25 23:56:19 2018 +0100

    improved documentation
---
 src/site/apt/index.apt.vm        |  9 +++++----
 src/site/apt/various-tips.apt.vm | 10 +++++-----
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 940faa8..f820919 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -37,7 +37,8 @@ ${project.name}
     generated by <<<maven-site-plugin>>> (see {{{https://issues.apache.org/jira/browse/MSITE-121}MSITE-121}}),
     which prevents simple content import to SCM.
 
-    The plugin has been tested with git scm too and by example can push content for github pages.
+    The plugin has been tested with git scm too and by example can
+    {{{./various-tips.html#Git_branch}push content for GitHub pages}}.
 
 
 * Implementation
@@ -81,8 +82,8 @@ mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:<scm-provider>... -Dscmpu
 
     There are 2 known limitations:
     
-    * for svn, the plugin can create the initial SCM directory if it does not exist. But for git by example, if you use a branch,
-    the branch won't be created: you have to create it manually,
+    * for Subversion, the plugin can create the initial SCM directory if it does not exist. But for Git by example, if you use a branch,
+    the branch won't be created: you have to {{{./various-tips.html#Git_branch}create it manually}},
 
     * the plugin works well for multi-module websites publishing to a complete directory:
     you just need to publish <<<mvn site:stage>>> content. But if one module does not publish
@@ -101,7 +102,7 @@ mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:<scm-provider>... -Dscmpu
 
     * fix inconsistent newlines generated by <<<maven-site-plugin>>> (caused by <<<site.vm>>> template and
       resources taken from skin jar without fixing newlines): {{{https://issues.apache.org/jira/browse/MSITE-121}MSITE-121}}
-      is fixed in (future) maven-site-plugin 3.4,
+      is fixed in maven-site-plugin 3.4,
 
     * improve {{{/wagon/wagon-providers/wagon-scm/}<<<wagon-scm>>>}} to put a whole directory content
       in one commit, and not with one commit per file.
diff --git a/src/site/apt/various-tips.apt.vm b/src/site/apt/various-tips.apt.vm
index e3a0618..6e13fc4 100644
--- a/src/site/apt/various-tips.apt.vm
+++ b/src/site/apt/various-tips.apt.vm
@@ -73,15 +73,15 @@ Various tips for using this plugin
     </plugin>
 +----------------+
 
-  Initial creation of the branch has to be done manually, as a Git orphan branch:
+  <<Initial creation of the branch has to be done manually>>, as a Git orphan branch:
 
-  * <<<git checkout --orphan gh-pages>>> to create the branch locally,
+  1. <<<git checkout --orphan gh-pages>>> to create the branch locally,
 
-  * <<<rm .git/index ; git clean -fdx>>> to clean the branch content and let it empy,
+  2. <<<rm .git/index ; git clean -fdx>>> to clean the branch content and let it empy,
 
-  * copy an initial site content,
+  3. copy an initial site content,
 
-  * commit and push: <<<git add *>>>, <<<git commit -m "initial site content">>>, <<<git push>>>
+  4. commit and push: <<<git add *>>>, <<<git commit -m "initial site content">>>, <<<git push>>>
 
   []
 

-- 
To stop receiving notification emails like this one, please contact
hboutemy@apache.org.