accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bhava...@apache.org
Subject svn commit: r1586426 - /accumulo/site/branches/redesign14/content/source.mdtext
Date Thu, 10 Apr 2014 19:04:05 GMT
Author: bhavanki
Date: Thu Apr 10 19:04:05 2014
New Revision: 1586426

URL: http://svn.apache.org/r1586426
Log:
Update source guide look and feel.

Modified:
    accumulo/site/branches/redesign14/content/source.mdtext

Modified: accumulo/site/branches/redesign14/content/source.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/branches/redesign14/content/source.mdtext?rev=1586426&r1=1586425&r2=1586426&view=diff
==============================================================================
--- accumulo/site/branches/redesign14/content/source.mdtext (original)
+++ accumulo/site/branches/redesign14/content/source.mdtext Thu Apr 10 19:04:05 2014
@@ -1,4 +1,5 @@
 Title: Apache Accumulo Source Code & Developers Guide
+Skiph1fortitle: true
 Nav: nav_source
 Notice:    Licensed to the Apache Software Foundation (ASF) under one
            or more contributor license agreements.  See the NOTICE file
@@ -17,29 +18,37 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-##  Source Code
+<div class="panel panel-default pull-right">
+<div class="panel-heading">Quick Links</div>
+<div class="list-group">
+<a href="https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=summary" class="list-group-item"><i
class="fa fa-external-link"></i> Accumulo source</a>
+<a href="https://builds.apache.org/job/Accumulo-Master/" class="list-group-item"><i
class="fa fa-external-link"></i> Master build on Jenkins</a>
+<a href="https://issues.apache.org/jira/browse/accumulo" class="list-group-item"><i
class="fa fa-external-link"></i> Accumulo JIRA</a>
+</div>
+</div>
+
+## Source Code
+
+### Apache Accumulo
 
 Apache Accumulo&trade; source code is maintained using [Git][git] version control 
 ([browse][cgit]|[checkout][anongit]).  It builds with [Apache Maven][maven].
 
-## Website
+Instructions for configuring git are [here](https://git-wip-us.apache.org/).
 
-Accumulo's web site is maintained with [Apache Subversion][subversion] [here][sitesvn] using
Apache's [Content Management System][cms].
-Committers may edit the site by following [these instructions][cmsusage].  Non-committers
should follow
-[this FAQ entry][cmsanon].
+### Contrib Projects
 
-## Contribs
+Accumulo has a number of [contrib projects](contrib.html) that maintain their own code repositories
and release schedules.
 
-Accumulo has a number of [contrib projects](contrib.html) that maintain their own code repositories
and release schedules. All build with [Apache Maven][maven].
+### Website
 
-* Instamo Archetype ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-instamo-archetype.git;a=summary)|[checkout](https://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype.git))
-* Wikisearch Application ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-wikisearch.git;a=summary)|[checkout](https://git-wip-us.apache.org/repos/asf/accumulo-wikisearch.git))
-* Apache Pig Support ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-pig.git;a=summary)|[checkout](https://git-wip-us.apache.org/repos/asf/accumulo-pig.git))
-* BSP via Apache Hama ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-bsp.git;a=summary)|[checkout](https://git-wip-us.apache.org/repos/asf/accumulo-bsp.git))
+Accumulo's web site is maintained with [Apache Subversion][subversion] [here][sitesvn] using
Apache's [Content Management System][cms].
+Committers may edit the site by following [these instructions][cmsusage].  Non-committers
should follow
+[this FAQ entry][cmsanon].
 
 ## Developer's Guide
 
-### Building code
+### Building
 
 #### Installing Thrift
 
@@ -51,13 +60,11 @@ need to install or modify the Thrift def
 
 #### Checking out from Git
 
-
 To check out the code:
 
     git clone http://git-wip-us.apache.org/repos/asf/accumulo.git
 
-#### Building
-
+#### Running a Build
 
 To build the code:
 
@@ -71,15 +78,15 @@ For older branches, "mvn package && mvn 
 
 Accumulo uses [Jenkins][jenkins] for automatic builds.
 
-<img src="https://builds.apache.org/job/Accumulo-Master/lastBuild/buildStatus" width=18>
[Master][masterbuild]
+<img src="https://builds.apache.org/job/Accumulo-Master/lastBuild/buildStatus" style="height:
1.1em"> [Master][masterbuild]
 
-<img src="https://builds.apache.org/job/Accumulo-1.6/lastBuild/buildStatus" width=18>
[1.6 Branch][16build]
+<img src="https://builds.apache.org/job/Accumulo-1.6/lastBuild/buildStatus" style="height:
1.1em"> [1.6 Branch][16build]
 
-<img src="https://builds.apache.org/job/Accumulo-1.5-Hadoop-2/lastBuild/buildStatus" width=18>
[1.5 Branch (Hadoop 2)][15buildh2]
+<img src="https://builds.apache.org/job/Accumulo-1.5-Hadoop-2/lastBuild/buildStatus" style="height:
1.1em"> [1.5 Branch (Hadoop 2)][15buildh2]
 
-<img src="https://builds.apache.org/job/Accumulo-1.5/lastBuild/buildStatus" width=18>
[1.5 Branch (Hadoop 1)][15build]
+<img src="https://builds.apache.org/job/Accumulo-1.5/lastBuild/buildStatus" style="height:
1.1em"> [1.5 Branch (Hadoop 1)][15build]
 
-<img src="https://builds.apache.org/job/Accumulo-1.4/lastBuild/buildStatus" width=18>
[1.4 Branch][14build]
+<img src="https://builds.apache.org/job/Accumulo-1.4/lastBuild/buildStatus" style="height:
1.1em"> [1.4 Branch][14build]
 
 ### Issue Tracking
 
@@ -87,7 +94,7 @@ Accumulo [tracks issues][jiraloc] with [
 
 ### Merging Practices
 
-Changes should be merged from earlier branches of Accumulo to later branches.  Ask the dev
list for instructions.
+Changes should be merged from earlier branches of Accumulo to later branches.  Ask the [dev
list][devlist] for instructions.
 
 ### Public API
 
@@ -97,27 +104,29 @@ Changes to non-private members of those 
 
 ### Coding Practices
 
-* License Header: Always add the current ASF license header as described in [ASF Source Header][srcheaders].
-* Trailing Whitespaces: Remove all trailing whitespaces. Eclipse users can use Source->Cleanup
option to accomplish this.
-* Indentation: Use 2 space indents and never use tabs!
-* Line Wrapping: Use 160-column line width for Java code and Javadoc.
-* Control Structure New Lines: Use a new line with single statement if/else blocks.
-* Author Tags: Do not use Author Tags. The code is developed and owned by the community.

+<table class="table">
+<tr><th>License Header</th><td>Always add the current ASF license
header as described in <a href="http://www.apache.org/legal/src-headers.html">ASF Source
Header</a>.</td></tr>
+<tr><th>Trailing Whitespaces</th><td>Remove all trailing whitespaces.
Eclipse users can use Source&rarr;Cleanup option to accomplish this.</td></tr>
+<tr><th>Indentation</th><td>Use 2 space indents and never use tabs!
+<tr><th>Line Wrapping</th><td>Use 160-column line width for Java
code and Javadoc.</td></tr>
+<tr><th>Control Structure New Lines</th><td>Use a new line with single
statement if/else blocks.</td></tr>
+<tr><th>Author Tags</th><td>Do not use Author Tags. The code is developed
and owned by the community.</td></tr>
+</table>
 
-### Eclipse Configuration Tips
+### IDE Configuration Tips
+
+#### Eclipse
 
 * Download Eclipse [formatting and style guides for Accumulo][styles].
 * Import Formatter: Preferences > Java > Code Style >  Formatter and import the
Eclipse-Accumulo-Codestyle.xml downloaded in the previous step. 
 * Import Template: Preferences > Java > Code Style > Code Templates and import the
Eclipse-Accumulo-Template.xml. Make sure to check the "Automatically add comments" box. This
template adds the ASF header and so on for new code.
 
-### Intellij Configuration Tips
- * Formatter [plugin](https://code.google.com/p/eclipse-code-formatter-intellij-plugin/)
that uses eclipse code style xml.
+#### IntelliJ
 
-### Git
-
- Instructions for configuring git are [here](https://git-wip-us.apache.org/).
+ * Formatter [plugin](https://code.google.com/p/eclipse-code-formatter-intellij-plugin/)
that uses eclipse code style xml.
 
 ### Release Guide
+
 Accumulo's release guide can be found [here][release].
 
 [subversion]: http://subversion.apache.org/
@@ -133,6 +142,7 @@ Accumulo's release guide can be found [h
 [14build]: https://builds.apache.org/job/Accumulo-1.4/
 [jiraloc]: https://issues.apache.org/jira/browse/accumulo
 [jira]: http://www.atlassian.com/software/jira/overview
+[devlist]: mailto:dev@accumulo.apache.org
 [release]: governance/releasing.html
 [cms]: http://www.apache.org/dev/cms.html
 [cmsusage]: http://www.apache.org/dev/cms.html#usage



Mime
View raw message