svn commit: r1786294 - /sling/site/trunk/content/documentation/development/release-management.mdtext

[bd...@apache.org]

Author: bdelacretaz
Date: Fri Mar 10 07:43:25 2017
New Revision: 1786294

URL: http://svn.apache.org/viewvc?rev=1786294&view=rev
Log:
Reword the Maven plugin docs steps, to be reviewed

Modified:
    sling/site/trunk/content/documentation/development/release-management.mdtext

Modified: sling/site/trunk/content/documentation/development/release-management.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/release-management.mdtext?rev=1786294&r1=1786293&r2=1786294&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/release-management.mdtext (original)
+++ sling/site/trunk/content/documentation/development/release-management.mdtext Fri Mar 10 07:43:25 2017
@@ -430,9 +430,10 @@ To update the OBR you may use the Apache
     update your checkout and then publish the site.
 
 
-## Appendix D: Deploy Maven plugin documentation
+## Appendix D: Deploy Maven plugin documentation (if applicable)
 
-For Maven plugins the Maven Site generated documentation with a list of supported goals and properties has to be published on the Slind website as well.
+When releasing a Maven plugin, the Maven-generated documentation published under http://sling.apache.org/components/ needs
+to be updated.
 
 This is currently supported for:
 
@@ -448,16 +449,16 @@ To publish the plugin documentation exec
    
         $ mvn clean site:site site:stage scm-publish:publish-scm
 
-3. Checkout the 'components' path of the Sling website
+3. Checkout the 'components' subtree of the Sling website
 
         $ svn checkout https://svn.apache.org/repos/infra/websites/production/sling/content/components
 
-4. SVN-rename the generate documenation uploaded to `<plugin-name>-archives/<plugin-name>-LATEST` to `<plugin-name>-archives/<plugin-name>-<version>`
+4. svn move the `<plugin-name>` subfolder there under <plugin-name>-archives/<plugin-name>-<version>`, if not present yet
 
-5. SVN-remove the existing folder `<plugin-name>` and SVN-copy the folder `<plugin-name>-archives/<plugin-name>-<version>` to `<plugin-name>`
+5. svn import the documentation generated by Maven site:site as `<plugin-name>' there.
 
 6. Commit the changes.
 
-7. Check the documentation at [http://sling.apache.org/components/](http://sling.apache.org/components/)
+7. Check the results at [http://sling.apache.org/components/](http://sling.apache.org/components/)
 
-For background information about this process see [here](http://maven.apache.org/developers/website/deploy-component-reference-documentation.html).
+For background information about this process see [the Maven components reference documentation](http://maven.apache.org/developers/website/deploy-component-reference-documentation.html).