Author: isudana
Date: Sun Aug 18 17:12:58 2019
New Revision: 1865401
URL: http://svn.apache.org/viewvc?rev=1865401&view=rev
Log:
Update site to include information on Github
Modified:
synapse/site/dev/developer-guide.html
synapse/site/dev/release-process.html
synapse/site/source-repository.html
Modified: synapse/site/dev/developer-guide.html
URL:
http://svn.apache.org/viewvc/synapse/site/dev/developer-guide.html?rev=1865401&r1=1865400&r2=1865401&view=diff
==============================================================================
--- synapse/site/dev/developer-guide.html (original)
+++ synapse/site/dev/developer-guide.html Sun Aug 18 17:12:58 2019
@@ -113,7 +113,7 @@
<ul>
<li>
- <a href="#subversion">Interacting with the Code Base Using
Subversion</a>
+ <a href="#git">Interacting with the Code Base Using Git</a>
<ul>
@@ -149,20 +149,15 @@
</li>
</ul>
</div>
- <a name="subversion"></a>
-<div class="section" id="subversion">
-<h2><a name="Interacting_with_the_Code_Base_Using_Subversion"></a>Interacting
with the Code Base Using Subversion</h2>
+ <a name="git"></a>
+<div class="section" id="git">
+<h2><a name="Interacting_with_the_Code_Base_Using_Git"></a>Interacting with
the Code Base Using Git</h2>
<p>
- Synapse code base is maintained in a Subversion repository.
Therefore, anyone willing
- to go through the Synapse source code in the development trunk
and make contributions
- should use a Subversion client to interact with the Synapse
code base. To learn more
- about using Subversion or to download the latest client
distributions, please visit
- the <a class="externalLink"
href="http://subversion.apache.org";>Apache Subversion project website</a>.
- Developers on Unix/Linux based systems may use the command
line based SVN client,
- while the developers on Windows platform can use an
appropriate client application
- like <a class="externalLink"
href="http://tortoisesvn.net/";>TortoiseSVN</a>.
- </p>
+ Synapse code base is maintained in a Github repository.
+ Therefore, anyone willing to go through the Synapse source code and make
contributions should use a Git client
+ to interact with the Synapse code base.
+</p>
<p>
Some useful information on using the Apache Software
Foundation's source code
@@ -174,29 +169,17 @@
<h3><a name="Checking_Out_the_Source"></a>Checking Out the Source</h3>
<p>
- Synapse development trunk is where all the latest
development work takes place.
- This is located at
- <a class="externalLink"
href="http://svn.apache.org/repos/asf/synapse/trunk/java/";>http://svn.apache.org/repos/asf/synapse/trunk/java/</a>.
- Any developer with a Subversion client should be able to
checkout the latest
- source from this SVN location but only Synapse committers
are allowed to actually
- commit source code. Synapse committers should access the
above SVN location over
- HTTPS and provide the ASF committer credentials to
checkout and commit source
- code. Please refer the <a
href="../source-repository.html">source repository guide</a>
- for more details on checking out the source code from the
above repository.
- </p>
-
-<p>
- Once you have checked out the source code, you can update
your working copy by
- running the 'svn update' command. This will checkout the
modifications since the
- last checkout/update and bring your local working copy to
the latest revision.
- </p>
+
+ Master branch of the Synapse Github repository is where all the latest
development work takes place.
+ This is located at
+ <a class="externalLink"
href="https://github.com/apache/synapse/tree/master";>
+ https://github.com/apache/synapse/tree/master</a>.
+ Any developer with a Git client should be able to checkout the latest
source from this location,
+ but only Synapse committers are allowed to merge Pull Requests to the
source code.
+ Please see the <a href="#contrib">Making Contributions</a> section for
more information on how developers can make
+ an contribution.
+</p>
-<p>
- If you want to browse the source code of an older release
of Synapse or want
- to implement a patch for a past release, you may checkout
the relevant source
- tree from one of the available SVN
- <a class="externalLink"
href="http://svn.apache.org/repos/asf/synapse/tags/";>tags</a>.
- </p>
</div>
</div>
<a name="maven"></a>
@@ -385,31 +368,36 @@ For Eclipse: mvn eclipse:eclipse</div>
<h2><a name="Making_Contributions"></a>Making Contributions</h2>
<p>
- If you have implemented a new feature, fixed some bug in the
code or written a new
- sample, we'll be more than happy to review it and include it
in the Synapse code
- base for everyone's benefit. If you are interested in
contributing your work to Synapse,
- please create an issue in the JIRA system first. Then you can
attach your workings to
- the JIRA issue as a patch.
- </p>
-
-<p>
- To create a patch file out of your work simply run the 'svn
diff' command.
- </p>
-
-<div class="command">svn diff > FixForIssue123.patch</div>
-
-<p>
- If you added any new files as a part of your work you should
first run the 'svn add'
- command on them before creating the patch file. Otherwise they
won't be included
- in the generated patch.
- </p>
+ If you have implemented a new feature, fixed some bug in the code or
written a new sample,
+ we'll be more than happy to review it and include it in the Synapse code
base for everyone's benefit.
+ If you are interested in contributing your work to Synapse,
+ please create an issue in the JIRA system first.
+ Then you can send a Github Pull Request contains the fixes to the Synapse
Github master branch.
+
+</p>
<p>
- Once the patch file has been created, attach it to the
relevant JIRA issue and make
- sure to grant the ASF permission to use your patch in ASF
development activities.
- One of the committers will review your work and provide
feedback through the JIRA. If
- all is well, the patch will eventually go into the Synapse
development trunk.
- </p>
+ To create a pull request follow the following approach,
+
+ <ul><li>Fork the Synapse Github repositoty</li></ul>
+ <ul><li>Take a checkout of your forked Github repository into local file
system</li></ul>
+ <ul><li>Switch to a new branch</li></ul>
+ <ul><li>Do required code fixes</li></ul>
+ <ul><li>Commit the fixes and push them together with the new branch to the
remote origin Github repository</li></ul>
+ <ul><li>Using the Github web UI, create a Pull Request from the branch
that contains fixes of forked Github
+ repository to master branch of Synapse Github repository</li></ul>
+</p>
+<p>
+ Once the Pull Request has been created, put a comment to the relevant JIRA.
+ One of the committers will review your work and provide feedback through
the Github Pull Request itself.
+ If all is well, the Pull Request will eventually get merged into the
Synapse development branch.
+</p>
+
+ <p>Same process applies even for committers.</p>
+ <p>It is recommended to submit a Pull Request for review rather
+ than directly committing to the code base.</p>
+</p>
+
</div>
Modified: synapse/site/dev/release-process.html
URL:
http://svn.apache.org/viewvc/synapse/site/dev/release-process.html?rev=1865401&r1=1865400&r2=1865401&view=diff
==============================================================================
--- synapse/site/dev/release-process.html (original)
+++ synapse/site/dev/release-process.html Sun Aug 18 17:12:58 2019
@@ -92,11 +92,9 @@
<p>
We follow the standard <a class="externalLink"
href="http://www.apache.org/dev/release-publishing.html";>ASF release
process</a>.
One of the committers would volunteer to play the release
manager role for a given
- release. A few days will be spent on stabilizing the Synapse
development trunk,
+ release. A few days will be spent on stabilizing the Synapse
development branch,
improving its documentation and test coverage. When the code
base is in a satisfactory
- state a release branch would be created under
- <a class="externalLink"
href="https://svn.apache.org/repos/asf/synapse/branches";>https://svn.apache.org/repos/asf/synapse/branches</a>.
- .
+ state a release branch would be created.
</p>
<p>
Modified: synapse/site/source-repository.html
URL:
http://svn.apache.org/viewvc/synapse/site/source-repository.html?rev=1865401&r1=1865400&r2=1865401&view=diff
==============================================================================
--- synapse/site/source-repository.html (original)
+++ synapse/site/source-repository.html Sun Aug 18 17:12:58 2019
@@ -85,35 +85,17 @@
</div>
<div id="bodyColumn" class="span10" >
<div class="section">
-<h2><a name="Overview"></a>Overview</h2><a name="Overview"></a>
-<p>This project uses <a class="externalLink"
href="http://subversion.apache.org/";>Subversion</a> to manage its source code.
Instructions on Subversion use can be found at <a class="externalLink"
href="http://svnbook.red-bean.com/";>http://svnbook.red-bean.com/</a>.</p></div>
-<div class="section">
-<h2><a name="Web_Access"></a>Web Access</h2><a name="Web_Access"></a>
-<p>The following is a link to the online source repository.</p>
-<div class="source"><pre class="prettyprint"><a class="externalLink"
href="http://svn.apache.org/viewvc/synapse/trunk/java";>http://svn.apache.org/viewvc/synapse/trunk/java</a></pre></div></div>
-<div class="section">
-<h2><a name="Anonymous_access"></a>Anonymous access</h2><a
name="Anonymous_access"></a>
-<p>The source can be checked out anonymously from SVN with this command:</p>
-<div class="source"><pre class="prettyprint">$ svn checkout
http://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div></div>
-<div class="section">
-<h2><a name="Developer_access"></a>Developer access</h2><a
name="Developer_access"></a>
-<p>Everyone can access the Subversion repository via HTTP, but Committers must
checkout the Subversion repository via HTTPS.</p>
-<div class="source"><pre class="prettyprint">$ svn checkout
https://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div>
-<p>To commit changes to the repository, execute the following command to
commit your changes (svn will prompt you for your password)</p>
-<div class="source"><pre class="prettyprint">$ svn commit --username
your-username -m "A message"</pre></div></div>
-<div class="section">
-<h2><a name="Access_from_behind_a_firewall"></a>Access from behind a
firewall</h2><a name="Access_from_behind_a_firewall"></a>
-<p>For those users who are stuck behind a corporate firewall which is blocking
HTTP access to the Subversion repository, you can try to access it via the
developer connection:</p>
-<div class="source"><pre class="prettyprint">$ svn checkout
https://svn.apache.org/repos/asf/synapse/trunk/java synapse</pre></div></div>
-<div class="section">
-<h2><a name="Access_through_a_proxy"></a>Access through a proxy</h2><a
name="Access_through_a_proxy"></a>
-<p>The Subversion client can go through a proxy, if you configure it to do so.
First, edit your "servers" configuration file to indicate which proxy
to use. The file's location depends on your operating system. On Linux or Unix
it is located in the directory "~/.subversion". On Windows it is in
"%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is
a hidden directory.)</p>
-<p>There are comments in the file explaining what to do. If you don't have
that file, get the latest Subversion client and run any command; this will
cause the configuration directory and template files to be created.</p>
-<p>Example: Edit the 'servers' file and add something like:</p>
-<div class="source"><pre class="prettyprint">[global]
-http-proxy-host = your.proxy.name
-http-proxy-port = 3128
-</pre></div></div>
+<h2><a name="Source Repository"></a>Source Repository</h2><a name="Source
Repository"></a>
+
+
+<p> This project uses Github to manage its source code.</p>
+<p>
+ Master branch of the Synapse Github repository is where all the latest
development work takes place.</p>
+<p> This is located at</p>
+
+ <a class="externalLink"
href="https://github.com/apache/synapse/tree/master";>https://github.com/apache/synapse/tree/master</a>
+
+ </div>
</div>
</div>
</div>
