Bug 507156 - Remove duplicated sop-addGerritContributer
- remove the duplicated file
- remove the reference in index.xml
- fix some typos
- add a reference to Hudson tab
Change-Id: Ie1246e6f09c3eb2eee2ecd396939cba0b992b3b9
Signed-off-by: Benoit Maggi <benoit.maggi@cea.fr>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/index.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/index.xml
index aed3e41..fcc5c8e 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/index.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/index.xml
@@ -12,7 +12,6 @@
</section>
<section name="Standard Operating Procedure">
<ul>
- <li><a href="sop-addGerritContributer.html">SOP Add gerrit contributer</a></li>
<li><a href="sop-releng.html">SOP Releng</a></li>
</ul>
</section>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-addGerritContributer.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-addGerritContributer.xml
deleted file mode 100644
index 7a37c59..0000000
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-addGerritContributer.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
-
- <properties>
- <title>sop-addGerritContributer</title>
- </properties>
-
- <body>
- <section name="Gerrit and whitelist">
- <p>Hudson is able to make the copy/paste from job folders to download folders. It introduces a security break. We have used the official mecanism to prevent code execution.</p>
- <p>If one of your contributers is not commiter, his contribution will be refused by the server as we execute:</p>
- <source>/shared/common/gerrit-utils/authorizeGerritBuild.sh papyrus/org.eclipse.papyrus-designer https://hudson.eclipse.org/papyrus /job/papyrus-designer-gerrit/244/ vancam.pham@cea.fr
- </source>
- <p>You need to add him manually in the whitelist of your project:</p>
- <source>ssh login@build.eclipse.org
- cd /opt/public/gerrit-contributor-whitelists/papyrus
- vi contributor_whitelist.txt
- </source>
- </section>
- </body>
-
-</document>
\ No newline at end of file
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-releng.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-releng.xml
index 0234259..1afb818 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-releng.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/relenger/sop-releng.xml
@@ -14,7 +14,7 @@
<subsection name="Prerequisites">
<p>Ensure the <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components/">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components/</a> is green.</p>
<p>Ensure that no critical bugs are opened <a href="https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=__open__&component=Components&product=Papyrus&query_format=specific">https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=__open__&component=Components&product=Papyrus&query_format=specific</a></p>
- <p>Have a look to the nighlty documentation in order to fetch the needed repository: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html</a></p>
+ <p>Have a look to the nightly documentation in order to fetch the needed repository: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html</a></p>
</subsection>
<subsection name="Actions">
<ul>
@@ -24,7 +24,7 @@
<li>Remove the -SNAPSHOT extension in the the following pom.xml: /org.eclipse.papyrus.components.parent/org.eclipse.papyrus.components.archetype/pom.xml, /org.eclipse.papyrus.components.parent/pom.xml. Other pom.xml do not have to be touched once they are automatically generated.</li>
<li>Merge these modifications</li>
<li>Run the job Components: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components/">papyrus-components</a></li>
- <li>Execute the job Components: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-nexus/">papyrus-components-deploy-nexus</a> by entering in the COMMITID field the commitid you would like to release. Usually it is the revision number in the last successfull build in Hudson or the last commit shown in the git log command.</li>
+ <li>Execute the job Components: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-nexus/">papyrus-components-deploy-nexus</a> by entering in the COMMITID field the commitid you would like to release. Usually it is the revision number in the last successful build in Hudson or the last commit shown in the git log command.</li>
<li>It should deploy the new version into the <a href="https://repo.eclipse.org/index.html#nexus-search;quick~org.eclipse.papyrus.components">nexus repository</a> and execute downstream the website job Components: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-website">papyrus-components-deploy-website</a>. The downstream jobs can be seen at the end of the build's console report.</li>
<li>Deploy the web site by copying the staging directory in the papyrus web git repository. To do this, first clone the <a href="http://git.eclipse.org/c/www.eclipse.org/papyrus.git/"> Papyrus Web git repository </a> and unzip in the components/components/ directory the unzipped built site from <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-website/ws/site-staging/*zip*/site-staging.zip"> papyrus-components-deploy-website </a></li>
<li>Modify the index.html to reflect the new release version by adding a new item to the dropdown menu and updating the referenced page address. This file can be found in the Papyrus Web git repository at the root of the components/components/ folder</li>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addDoc.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addDoc.xml
index 93b8970..6c1b66d 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addDoc.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addDoc.xml
@@ -35,7 +35,7 @@
<ul>
<li>user: people that will use your product</li>
<li>developer: people that will develop your product</li>
- <li>relenger: committers that will be in charge of making the
+ <li>relenger: committer that will be in charge of making the
release of your product
</li>
</ul>
@@ -86,7 +86,7 @@
<p>
calling the MyLyn mediawiki maven plugin in the pom.xml
You plugin will contains a site directory that will hold your
- mediawiki documentation with it embbeded resources such as images.
+ mediawiki documentation with it embedded resources such as images.
The mediawiki files will be processed by a maven wiki plugin. Here
some details of the configuration. It will generate a toc file and
the corresponding html file in the output folder. If you want more
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addGerritContributer.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addGerritContributer.xml
index 7a37c59..fd9ebd4 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addGerritContributer.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addGerritContributer.xml
@@ -8,11 +8,11 @@
<body>
<section name="Gerrit and whitelist">
- <p>Hudson is able to make the copy/paste from job folders to download folders. It introduces a security break. We have used the official mecanism to prevent code execution.</p>
- <p>If one of your contributers is not commiter, his contribution will be refused by the server as we execute:</p>
- <source>/shared/common/gerrit-utils/authorizeGerritBuild.sh papyrus/org.eclipse.papyrus-designer https://hudson.eclipse.org/papyrus /job/papyrus-designer-gerrit/244/ vancam.pham@cea.fr
+ <p>Hudson is able to make the copy/paste from job folders to download folders. It introduces a security break. We have used the official mechanism to prevent code execution.</p>
+ <p>If one of your contributers is not committer, his contribution will be refused by the server as we execute:</p>
+ <source>/shared/common/gerrit-utils/authorizeGerritBuild.sh papyrus/org.eclipse.papyrus-designer https://hudson.eclipse.org/papyrus /job/papyrus-designer-gerrit/244/ example@mycompany.com
</source>
- <p>You need to add him manually in the whitelist of your project:</p>
+ <p>You need to add him manually in the white-list of your project:</p>
<source>ssh login@build.eclipse.org
cd /opt/public/gerrit-contributor-whitelists/papyrus
vi contributor_whitelist.txt
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml
index 0829a79..798f2a5 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml
@@ -9,7 +9,7 @@
<body>
<section name="sop-release">
<subsection name="Who is in charge of?">
- <p>Commiter + a basic developer in order to transfer knowledge and improve the process.</p>
+ <p>Committer + a basic developer in order to transfer knowledge and improve the process.</p>
</subsection>
<subsection name="When?">
<p>when you need it, on a regular basis, every two month.</p>
@@ -50,7 +50,7 @@
<p>Your initial platforms are perhaps using a version setted to 0.0.0. To release your project we advice you to replace this 0.0.0 by the version of the day.</p>
<p>Execute the following command on the target platform you are matching:</p>
<source>mvn org.eclipse.tycho.extras:tycho-version-bump-plugin:update-target -Dtarget=/home/flefevre/gitNeon/org.eclipse.papyrus-marte/targetplatform/org.eclipse.papyrus.marte.targetplatform.neon/org.eclipse.papyrus.marte.targetplatform.neon.target </source>
- <p>It should replace all 0.0.0 version by a strick identified version of all needed features.</p>
+ <p>It should replace all 0.0.0 version by a strict identified version of all needed features.</p>
</subsection>
<subsection name="Upgrade the version of application - version 1">
<p>Remove the .qualifier, -SNAPSHOT extension in the different pom.xml, manifest.mf artifact version.</p>
@@ -80,19 +80,19 @@
<p>Goal is to use this job version as data for the promotion.</p>
</subsection>
<subsection name="Make the release">
- <p>Who: commiter action</p>
- <p>Go the hudson Component tab</p>
+ <p>Who: committer action</p>
+ <p>Go the Hudson <a href="https://hudson.eclipse.org/papyrus/view/Component/">Component tab</a></p>
<p>Execute the job papyrus-component-deploy-eclipse</p>
<p>Fill the args</p>
- <p>It should tag the release automatically, you copuld check it by looking at the git repository</p>
+ <p>It should tag the release automatically, you have to check it by looking at the git repository</p>
<p>It should also automatically execute the job papyrus-component-deploy-nexus: to deploy the artifact into the Eclipse Papyrus official Nexus</p>
<p>It should also automatically execute the job and papyrus-component-deploy-website</p>
</subsection>
<subsection name="Deploy the web site">
- <p>Who: uncommiter action + commiter review</p>
+ <p>Who: non-committer action + committer review</p>
<p>The new web site is available under the target/site-staging directory</p>
<p>Download it as a zip</p>
- <p>Unzip it in the papyrus web git repository, under the papyrus/components/YourComponent directort</p>
+ <p>Unzip it in the Papyrus web git repository, under the papyrus/components/YourComponent directory</p>
<p>Update the root index.html with the new version of your component</p>
<source>https://git.eclipse.org/c/www.eclipse.org/papyrus-sysml.git/</source>
<p>Ask for validation for the review.</p>
@@ -106,7 +106,7 @@
<p>Push it as new patch and make the review.</p>
</subsection>
<subsection name="Restore eventually the 0.0.0 in the target platform">
- <p>It could be good to restore the 0.0.0 version in your futur target platform</p>
+ <p>It could be good to restore the 0.0.0 version in your future target platform</p>
</subsection>
</section>
<section name="Post-Actions">
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-releng.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-releng.xml
index 7c2aa0d..e258137 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-releng.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-releng.xml
@@ -15,7 +15,7 @@
<subsection name="Prerequisites">
<p>Ensure your Hudson jobs are green <a href="https://hudson.eclipse.org/papyrus/view/COMPONENTS/job/">https://hudson.eclipse.org/papyrus/view/COMPONENTS/job/</a>.</p>
<p>Ensure that no critical bugs are opened <a href="https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=__open__&component=Components&product=Papyrus&query_format=specific">https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=__open__&component=Components&product=Papyrus&query_format=specific</a></p>
- <p>Have a look to the nighlty documentation in order to fetch the needed repository: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html</a></p>
+ <p>Have a look to the nightly documentation in order to fetch the needed repository: <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-website/ws/site-staging/index.html</a></p>
</subsection>
<subsection name="Actions">
<ul>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-targetPlatformUpdate.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-targetPlatformUpdate.xml
index 5050648..cebb10d 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-targetPlatformUpdate.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-targetPlatformUpdate.xml
@@ -9,7 +9,7 @@
<body>
<section name="Context">
<p>All components are based upon a set of targets platform localized at the targetplatform directory. You can update them with the Obeo plugin or directly from a maven command.</p>
- <p>It will switch resolve all feature with the latest ones found on the different update site you are refering.</p>
+ <p>It will switch resolve all feature with the latest ones found on the different update site you are referring.</p>
</section>
<section name="How to?">
<subsection name="Pre-requisite">
