Ian Maxon has submitted this change and it was merged. Change subject: ASTERIXDB-1217: remove references to Google Code ......................................................................
ASTERIXDB-1217: remove references to Google Code Also make the Jekyll configuration a little more convenient. Change-Id: I3a451b90ae2dbf8bcff23bf3cd9902d7b51e4ec9 Reviewed-on: https://asterix-gerrit.ics.uci.edu/542 Reviewed-by: Ian Maxon <[email protected]> --- M content/dev-setup.html M dev-setup.md 2 files changed, 66 insertions(+), 75 deletions(-) Approvals: Ian Maxon: Looks good to me, approved diff --git a/content/dev-setup.html b/content/dev-setup.html index f3557d6..8fc70e3 100644 --- a/content/dev-setup.html +++ b/content/dev-setup.html @@ -140,34 +140,31 @@ <h3 id="steps">Steps</h3> <ol> - <li>Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</li> -</ol> + <li> + <p>Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</p> -<pre><code> git clone https://github.com/apache/incubator-asterixdb/ - git clone https://github.com/apache/incubator-asterixdb-hyracks/ - -You will now have `$HOME/workspace/incubator-asterixdb/` and `$HOME/workspace/incubator-asterixdb-hyracks/`. + <pre><code> git clone https://github.com/apache/incubator-asterixdb/ + git clone https://github.com/apache/incubator-asterixdb-hyracks/ </code></pre> -<ol> - <li>Go to the hyracks and install it’s artifacts to the local Maven repository by executing the following commands:</li> -</ol> + <p>You will now have <code>$HOME/workspace/incubator-asterixdb/</code> and <code>$HOME/workspace/incubator-asterixdb-hyracks/</code>.</p> + </li> + <li> + <p>Go to the hyracks and install it’s artifacts to the local Maven repository by executing the following commands:</p> -<pre><code> cd incubator-asterixdb-hyracks/ - mvn install -DskipTests + <pre><code> cd incubator-asterixdb-hyracks/ + mvn install -DskipTests </code></pre> + </li> + <li> + <p>Go to the asterixdb folder and perform the same action:</p> -<ol> - <li>Go to the asterixdb folder and perform the same action:</li> -</ol> - -<pre><code> cd ../incubator-asterixdb/asterix-maven-plugins/ - mvn install -DskipTests - cd ../ - mvn install -DskipTests + <pre><code> cd ../incubator-asterixdb/asterix-maven-plugins/ + mvn install -DskipTests + cd ../ + mvn install -DskipTests </code></pre> - -<ol> + </li> <li>In Eclipse, import hyracks as an existing Maven Project. <ul> <li><code>File -> Import -> Maven -> Existing Maven Projects -> Next</code></li> @@ -200,7 +197,8 @@ </li> <li>Set up Eclipse code formatting rules <ul> - <li>Download files <a href="http://wiki.asterixdb.googlecode.com/git/AsterixCodeFormatProfile.xml";>AsterixCodeFormatProfile.xml</a> <a href="http://wiki.asterixdb.googlecode.com/git/AsterixCleanupFormatProfile.xml";>AsterixCleanupFormatProfile.xml</a></li> + <li>Download files <a href="https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCodeFormatProfile.xml";>AsterixCodeFormatProfile.xml</a> + <a href="https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCleanupFormatProfile.xml";>AsterixCleanupFormatProfile.xml</a></li> <li>Import profiles into Eclipse <ul> <li>Preferences -> Java -> Code style -> Formatter -> Import -> Select AsterixCodeFormatProfile.xml</li> @@ -276,68 +274,62 @@ <h3 id="once-per-repository-tasks">Once-per-repository tasks</h3> <ol> - <li>To work on (say) Asterix, first clone the Google Code repository (if you already have a local clone, great!).</li> + <li> + <p>To work on (say) Asterix, first clone the GitHub mirror or the ASF repository (if you already have a local clone, great!), e.g.</p> + + <p>git clone https://github.com/apache/incubator-asterixdb</p> + </li> + <li> + <p><code>cd</code> into the clone repo directory, and then run the following command to create the “gerrit” remote.</p> + + <p>git gerrit init</p> + </li> </ol> - -<pre><code> git clone https://github.com/apache/incubator-asterixdb -</code></pre> - -<ol> - <li><code>cd</code> into the clone repo directory, and then run the following command to create the “gerrit” remote.</li> -</ol> - -<pre><code> git gerrit init -</code></pre> <hr /> <h2 id="making-changes---working-method">Making Changes - working method</h2> <ol> - <li>When you want to start working on a bug, feature, etc, first make a local <code>git</code> branch. Never work directly on <code>master</code>! <code>master</code> should always be a pure mirror of <code>origin/master</code>, ie, Google Code.</li> -</ol> + <li> + <p>When you want to start working on a bug, feature, etc, first make a local <code>git</code> branch. Never work directly on + <code>master</code>! <code>master</code> should always be a pure mirror of <code>origin/master</code>, i.e., the GitHub mirror or the ASF repository.</p> -<pre><code> git checkout -b my_branch + <pre><code> git checkout -b my_branch </code></pre> + </li> + <li> + <p>Make your changes, test them, etc. Feel free to <code>git commit</code> as often as you like.</p> + </li> + <li> + <p><strong>Optional</strong>: If you like, you can push your branch up to another git repository (e.g. in your own GitHub account), either to share it with others or as a backup. You may do this at whatever point in time you like.</p> + </li> + <li> + <p>Every so often, you should update your local <code>master</code> mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with <code>master</code>. There are a number of ways to do this, but <code>git-gerrit</code> provides a convenience function:</p> -<ol> - <li>Make your changes, test them, etc. Feel free to <code>git commit</code> as often as you like.</li> - <li><strong>Optional</strong>: If you like, you can push your branch up to Google Code, either to share it with others or as a backup. You may do this at whatever point in time you like.</li> -</ol> - -<pre><code> git push origin my_branch + <pre><code> git gerrit update </code></pre> + </li> + <li> + <p>When you are ready to submit changes for code review, first ensure that you have committed everything locally that is necessary (<code>git status</code> should report “nothing to commit, working directory clean”). This is also a good time to update (see step 4). Then run:</p> -<ol> - <li>Every so often, you should update your local <code>master</code> mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with <code>master</code>. There are a number of ways to do this, but <code>git-gerrit</code> provides a convenience function:</li> -</ol> - -<pre><code> git gerrit update + <pre><code> git gerrit submit </code></pre> - -<ol> - <li>When you are ready to submit changes for code review, first ensure that you have committed everything locally that is necessary (<code>git status</code> should report “nothing to commit, working directory clean”). This is also a good time to update (see step 4). Then run:</li> -</ol> - -<pre><code> git gerrit submit -</code></pre> - -<ol> + </li> <li>This will pop open your editor to invite you to create a good commit message. This will be the single commit message which will be the only one to appear in the project’s master git history. Take the time to make it clear. The editor will contain the log messages of everything you committed on your branch as a reminder, but generally you will want to delete all this and replace it with a comprehensive message. Also: As noted in the initial message, the last line of the buffer will contain a <code>Change-Id</code> field. Do not delete that line! It is used by Gerrit to identify this particular merge proposal.</li> - <li>When you save your commit message, git-gerrit will push all of the changes from your working branch up to Gerrit. Assuming no errors, you should see output similar to the following:</li> -</ol> + <li> + <p>When you save your commit message, git-gerrit will push all of the changes from your working branch up to Gerrit. Assuming no errors, you should see output similar to the following:</p> -<pre><code> remote: Resolving deltas: 100% (1/1) - remote: Processing changes: new: 1, refs: 1, done - remote: - remote: New Changes: - remote: http://fulliautomatix.ics.uci.edu:8443/30 - remote: - To ssh://[email protected]:29418/ceej-gerrit-test - * [new branch] HEAD -> refs/for/master + <pre><code> remote: Resolving deltas: 100% (1/1) + remote: Processing changes: new: 1, refs: 1, done + remote: + remote: New Changes: + remote: http://fulliautomatix.ics.uci.edu:8443/30 + remote: + To ssh://[email protected]:29418/ceej-gerrit-test + * [new branch] HEAD -> refs/for/master </code></pre> - -<ol> + </li> <li>That URL under “New Changes” is your code review! Send it to others to request reviews.</li> <li>If you get any negative code reviews and need to make changes, you can just repeat steps 2 - 6 of the working method. Your local branch will still have all the history you put there, if you need to revert changes or look back and see what you did, etc.</li> <li>When you repeat step 6, you will notice two things: First, git-gerrit keeps the change message for you, including the Change-Id, so you don’t have to re-invent it every time. Second, the output from <code>git gerrit submit</code> will not include the URL of the review this time. I’m not sure why; I wish it did. But if you re-visit the old URL in your browser, you should see an additional “Patch Set” containing your revised changes for people to review.</li> diff --git a/dev-setup.md b/dev-setup.md index 282d6f8..9ea4b2c 100644 --- a/dev-setup.md +++ b/dev-setup.md @@ -79,7 +79,8 @@ * Repeat this step to all projects which show a red X mark except "asterix-fuzzyjoin" and "asterix-transactions". * It may be the case that only "asterix-algebra" and "asterix-runtime" will require these steps. 7. Set up Eclipse code formatting rules -* Download files [AsterixCodeFormatProfile.xml](http://wiki.asterixdb.googlecode.com/git/AsterixCodeFormatProfile.xml) [AsterixCleanupFormatProfile.xml](http://wiki.asterixdb.googlecode.com/git/AsterixCleanupFormatProfile.xml) +* Download files [AsterixCodeFormatProfile.xml](https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCodeFormatProfile.xml) + [AsterixCleanupFormatProfile.xml](https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCleanupFormatProfile.xml) * Import profiles into Eclipse * Preferences -> Java -> Code style -> Formatter -> Import -> Select AsterixCodeFormatProfile.xml * Preferences -> Java -> Code style -> Clean up -> Import -> Select AsterixCleanupFormatProfile.xml @@ -144,7 +145,7 @@ ### Once-per-repository tasks - 1. To work on (say) Asterix, first clone the Google Code repository (if you already have a local clone, great!). + 1. To work on (say) Asterix, first clone the GitHub mirror or the ASF repository (if you already have a local clone, great!), e.g. git clone https://github.com/apache/incubator-asterixdb @@ -157,16 +158,14 @@ ## Making Changes - working method - 1. When you want to start working on a bug, feature, etc, first make a local `git` branch. Never work directly on `master`! `master` should always be a pure mirror of `origin/master`, ie, Google Code. - + 1. When you want to start working on a bug, feature, etc, first make a local `git` branch. Never work directly on + `master`! `master` should always be a pure mirror of `origin/master`, i.e., the GitHub mirror or the ASF repository. git checkout -b my_branch - 1. Make your changes, test them, etc. Feel free to `git commit` as often as you like. - 1. **Optional**: If you like, you can push your branch up to Google Code, either to share it with others or as a backup. You may do this at whatever point in time you like. - git push origin my_branch + 1. **Optional**: If you like, you can push your branch up to another git repository (e.g. in your own GitHub account), either to share it with others or as a backup. You may do this at whatever point in time you like. 1. Every so often, you should update your local `master` mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with `master`. There are a number of ways to do this, but `git-gerrit` provides a convenience function: -- To view, visit https://asterix-gerrit.ics.uci.edu/542 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: merged Gerrit-Change-Id: I3a451b90ae2dbf8bcff23bf3cd9902d7b51e4ec9 Gerrit-PatchSet: 3 Gerrit-Project: incubator-asterixdb-site Gerrit-Branch: asf-site Gerrit-Owner: Till Westmann <[email protected]> Gerrit-Reviewer: Ian Maxon <[email protected]> Gerrit-Reviewer: Jenkins <[email protected]>
