http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/database-support.html ---------------------------------------------------------------------- diff --git a/database-support.html b/database-support.html new file mode 100644 index 0000000..f46153e --- /dev/null +++ b/database-support.html @@ -0,0 +1,354 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>Database Support · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + <section> + <article> + <h1 class="text-center">Database Support</h1> + <p>This page provides useful information about JDBC driver settings for various database. All databases below have custom Cayenne DbAdapters and are automatically recognized by Cayenne AutoAdapter.</p> + +<table> +<thead> +<tr> +<th>Database</th> +<th>Driver Name</th> +<th>Sample URL</th> +<th>Notes</th> +</tr> +</thead> + +<tbody> +<tr> +<td><a href="http://www.ibm.com/db2/";>DB2</a></td> +<td>com.ibm.db2.jcc.DB2Driver</td> +<td>jdbc:db2://127.0.0.1:50000/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://db.apache.org/derby/";>Derby</a></td> +<td>org.apache.derby.jdbc.ClientDriver</td> +<td>jdbc:derby://127.0.0.1/testdb</td> +<td>client/server</td> +</tr> + +<tr> +<td></td> +<td>org.apache.derby.jdbc.EmbeddedDriver</td> +<td>jdbc:derby:path-to-db-dir;create=true</td> +<td>embedded</td> +</tr> + +<tr> +<td><a href="http://www.frontbase.com/";>FrontBase</a></td> +<td>jdbc.FrontBase.FBJDriver</td> +<td>jdbc:FrontBase://127.0.0.1/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://hsqldb.org/";>HSQLDB</a></td> +<td>org.hsqldb.jdbcDriver</td> +<td>jdbc:hsqldb:hsql://127.0.0.1</td> +<td>client/server</td> +</tr> + +<tr> +<td></td> +<td>jdbc:hsqldb:</td> +<td>file:/path-to-hsql-db-files</td> +<td>embedded</td> +</tr> + +<tr> +<td><a href="www.h2database.com/">H2</a></td> +<td>org.h2.Driver</td> +<td>jdbc:h2:mem:myTestMem;MVCC=TRUE</td> +<td>embedded in-memory</td> +</tr> + +<tr> +<td><a href="http://www.ingres.com/products/ingres-database.php";>Ingres</a></td> +<td>com.ingres.jdbc.IngresDriver</td> +<td>jdbc:ingres://127.0.0.1:II7/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://www.mysql.com/";>MySQL</a></td> +<td>com.mysql.jdbc.Driver</td> +<td>jdbc:mysql://127.0.0.1/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="www.openbase.com">OpenBase</a></td> +<td>com.openbase.jdbc.ObDriver</td> +<td>jdbc:openbase://127.0.0.1/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://www.oracle.com/";>Oracle</a></td> +<td>oracle.jdbc.driver.OracleDriver</td> +<td>jdbc:oracle:thin:@//127.0.0.1:1521/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://www.postgresql.org/";>PostgreSQL</a></td> +<td>org.postgresql.Driver</td> +<td>jdbc:postgresql://127.0.0.1:5432/dbname</td> +<td></td> +</tr> + +<tr> +<td><a href="http://www.sqlite.org/";>SQLite 3.*</a></td> +<td>org.sqlite.JDBC</td> +<td>jdbc:sqlite:path_to_dbfile</td> +<td>driver from zentus.com</td> +</tr> + +<tr> +<td><a href="http://www.microsoft.com/sqlserver";>SQLServer</a></td> +<td><a href="http://msdn.microsoft.com/en-us/data/aa937724.aspx";>com.microsoft.sqlserver.jdbc.SQLServerDriver</a></td> +<td>jdbc:sqlserver://127.0.0.1;databaseName=dbname</td> +<td>Microsoft Driver</td> +</tr> + +<tr> +<td></td> +<td>com.microsoft.jdbc.sqlserver.SQLServerDriver</td> +<td>jdbc:microsoft:sqlserver://127.0.0.1;databaseName=dbname;SelectMethod=cursor</td> +<td>Microsoft Driver, SQL Server prior to 2005</td> +</tr> + +<tr> +<td></td> +<td>net.sourceforge.jtds.jdbc.Driver</td> +<td>jdbc:jtds:sqlserver://127.0.0.1:5000/dbname</td> +<td><a href="http://jtds.sourceforge.net/";>jTDS Driver</a></td> +</tr> + +<tr> +<td><a href="http://www.sybase.com/";>Sybase</a></td> +<td>com.sybase.jdbc3.jdbc.SybDriver</td> +<td>jdbc:sybase:Tds:127.0.0.1:5000/dbname</td> +<td>Sybase driver</td> +</tr> + +<tr> +<td></td> +<td>net.sourceforge.jtds.jdbc.Driver</td> +<td>jdbc:jtds:sybase://127.0.0.1:5000/dbname;useLOBs=false;TDS=4.2</td> +<td><a href="http://jtds.sourceforge.net/";>jTDS Driver</a></td> +</tr> +</tbody> +</table> + + </article> + </section> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/dev/building-cayenne.html ---------------------------------------------------------------------- diff --git a/dev/building-cayenne.html b/dev/building-cayenne.html new file mode 100644 index 0000000..acddbf4 --- /dev/null +++ b/dev/building-cayenne.html @@ -0,0 +1,304 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>Building Cayenne · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + + <section> + <article> + <h1 class="text-center">Building Cayenne</h1> + + +<h2 id="prerequisites">Prerequisites</h2> + +<ul> +<li>Make sure <a href="http://maven.apache.org/";>Maven</a> is installed.</li> +<li><a href="/dev/code-repository.html">Get the source code</a>.</li> +</ul> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="recommended-maven-settings">Recommended Maven Settings</h2> + +<p>Here are the MAVEN_OPTS that should be used for the build. MAVEN_OPTS variable can either be exported in a shell, +or placed in <em>$HOME/.mavenrc</em>. Optimal values vary from platform to platform and between Cayenne versions, +but these should probably work for everyone:</p> + +<pre><code>MAVEN_OPTS="-Djava.net.preferIPv4Stack=true -Xms512m -Xmx512m -XX:MaxPermSize=128m" +</code></pre> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="building-with-maven">Building with Maven</h2> + +<p>Depending on what you want to do, there are various flavors of the builds +discussed below. All builds should be executed from the root folder of the source checkout.</p> + +<p>Building the framework and installing it to the local repository (the most +common flavor) :</p> + +<pre><code>mvn clean install +</code></pre> + +<p>In order to skip the unit tests (to speed up the build process or because +some tests are failing), add <em>”-Dmaven.test.skip=true”</em> to any build +flavor:</p> + +<pre><code>mvn clean install -Dmaven.test.skip=true +</code></pre> + +<p>For the build to produce a release-like assembly, activate “assembly” +profile. Additionally activate a profile specific for the target platform +of a given assembly (otherwise assembly profile won’t produce anything).</p> + +<p>Source assembly:</p> + +<pre><code>mvn clean install -Passembly,src +</code></pre> + +<p>Cross-platform assembly:</p> + +<pre><code>mvn clean install -Passembly,generic +</code></pre> + +<p>Windows assembly:</p> + +<pre><code>mvn clean install -Passembly,windows +</code></pre> + +<p>Mac OS X assembly:</p> + +<pre><code>mvn clean install -Passembly,mac +</code></pre> + +<p>Multiple assemblies built at once: + mvn clean install -Passembly,src,generic,mac</p> + + </article> + </section> + + + <div class="pb-3"></div> + <div class="row"> + <div class="col-12 col-md-6 text-center text-md-left"> + + <a class="btn btn-link" href='/dev/eclipse.html'> + <span class="d-block d-md-none text-muted">Prev: </span> + <i class="small fa fa-chevron-left mr-3l2 d-none d-md-inline"></i> + Working with Cayenne code in Eclipse + </a> + + </div> + <div class="col-12 col-md-6 text-center text-md-right"> + + <a class="btn btn-link" href='/dev/release-guide.html'> + <span class="d-block d-md-none text-muted">Next: </span> + Release Guide + <i class="small fa fa-chevron-right ml-3l2 d-none d-md-inline"></i> + </a> + + </div> + </div> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/dev/cms-guide.html ---------------------------------------------------------------------- diff --git a/dev/cms-guide.html b/dev/cms-guide.html new file mode 100644 index 0000000..65256a3 --- /dev/null +++ b/dev/cms-guide.html @@ -0,0 +1,351 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>Guide to Cayenne CMS · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + + <section> + <article> + <h1 class="text-center">Guide to Cayenne CMS</h1> + + +<p>Cayenne Site source code (content + styling + scripts) can be obtained from Apache Git repo:<br /> +<a href="https://git-wip-us.apache.org/repos/asf/cayenne-website.git";>https://git-wip-us.apache.org/repos/asf/cayenne-website.git</a></p> + +<p>Or from GitHub mirror (in read only mode): <a href="https://github.com/apache/cayenne-website.git";>https://github.com/apache/cayenne-website.git</a></p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="dev-mode">Dev mode</h2> + +<p>Just clone and run maven, nothing else required.</p> + +<pre><code>git clone https://git-wip-us.apache.org/repos/asf/cayenne-website.git +cd cayenne-website +mvn +</code></pre> + +<p>Open <a href="http://localhost:3000";>http://localhost:3000</a> in your browser. In dev mode site supports live-reloading.</p> + +<p><em>You can change host and port by setting <code>dev.host</code> and <code>dev.port</code> properties:</em></p> + +<pre><code>mvn -Ddev.host="my.local" -Ddev.port="8080" +</code></pre> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="publish">Publish</h2> + +<p>To publish new version just run Maven with <code>publish</code> profile. This will build production version of the site (with <code>cayenne.apache.org</code> base URL) and push commit into <code>asf-site</code> branch that will be synced with actual site content location:</p> + +<pre><code>mvn -Ppublish -Dmsg="commit message describing site changes" +</code></pre> + +<p>That’s all, so be carefull and review your changes before publishing (also don’t forget to check them after).</p> + +<p>Don’t forget to push you source’s changes so others won’t rewrite them.</p> + +<p>:grey_exclamation: apache <code>gitpubsub</code> should be setup in order actual content sync to happen.</p> + +<p><em>NOTE</em>: This process can be automated by Jenkins. It can run publish on every commit to <code>master</code>. But at first it is better to use manual publishing.</p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="content-modifications">Content modifications</h2> + +<h3 id="publishing-news">Publishing news</h3> + +<p>To publish news simply add new file at <code>src/main/site/content/news/</code> folder. +You can use following template:</p> + +<p><code>some-good-news.md</code></p> + +<pre><code>--- +title: Good news everyone! +date: 2017-01-01T00:00:00+03:00 +--- + +Content goes here +</code></pre> + +<h3 id="releasing-new-cayenne-version">Releasing new cayenne version</h3> + +<p>To update site content with information about new Cayenne version you need to perform these steps:</p> + +<ul> +<li>Update data in <code>src/main/site/data/cayenne.yaml</code> file.</li> +<li>Write news (see information above).</li> +<li>Update documentation, this can be done with <code>build-docs.sh</code> script. +You can run it like this: <code>./build-docs.sh 4.1.M2</code></li> +</ul> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="advanced">Advanced</h2> + +<p>Node.js, Yarn, Gulp and Hugo used to build this site, Maven used just to boostrap Node.js and Yarn tools and launch Gulp tasks. +Hugo binaries managed by <a href="https://www.npmjs.com/package/hugo-bin";>hugo-bin</a> NPM module.</p> + +<h3 id="src-structure">Src structure</h3> + +<p>There is two main parts of site src:</p> + +<ul> +<li><p><code>src/main/assets</code> assets processed by <a href="https://gulpjs.com";>Gulp</a> tasks</p> + +<ul> +<li><code>/gulp/</code> - list of Gulp tasks: + +<ul> +<li><code>hugo.js</code> - contains tasks that launch Hugo to process all content</li> +<li><code>images.js</code> - compress and copy images</li> +<li><code>reference.js</code> - replace references to generated resources inside content</li> +<li><code>revision.js</code> - generate manifest file with resources versions</li> +<li><code>scripts.js</code> - launch Webpack to process JavaScript resources</li> +<li><code>serve.js</code> - launch dev-version of site with live-reloading</li> +<li><code>styles.js</code> - generate CSS bundle (concat, minify, etc..)</li> +</ul></li> +<li><code>/images/</code> - images that will be compressed and published into site <code>/img</code> directory, +you can put any stuff used by site here (see <code>/gulp/images.js</code>)</li> +<li><code>/scripts/</code> - JavaScript sources, <code>main.js</code> is an entry point for the final bundle, +will be processed by Webpack (see <code>/gulp/scripts.js</code>)</li> +<li><code>/styles/</code> - Sass sources, <code>main.scss</code> is an entry point for the final bundle +(see <code>/gulp/styles.js</code>)</li> +<li><code>gulpfile.js</code> - main file for Gulp tasks, define some global path constants</li> +<li><code>package.json</code> - all project dependencies are defined here</li> +</ul></li> + +<li><p><code>src/main/site</code> assets processed <a href="https://gohugo.io";>Hugo</a> site generator</p> + +<ul> +<li><code>/content/</code> - main content part of the site, markdown and HTML files</li> +<li><code>/data/</code> - data files in <em>yaml</em> format</li> +<li><code>/layouts/</code> - site templates, using <a href="https://golang.org/pkg/text/template/";>GO templates</a></li> +<li><code>/static/</code> - files that will be copied as is to the final site content, note that <code>js</code>, <code>img</code> and <code>css</code> directories +are processed via Gulp tasks, and shouldn’t be used directly, instead use coresponding directories in <code>assets</code>.<br /></li> +<li><code>config.yaml</code> - Hugo configuration</li> +</ul></li> +</ul> + + </article> + </section> + + + <div class="pb-3"></div> + <div class="row"> + <div class="col-12 col-md-6 text-center text-md-left"> + + <a class="btn btn-link" href='/dev/running-unit-tests.html'> + <span class="d-block d-md-none text-muted">Prev: </span> + <i class="small fa fa-chevron-left mr-3l2 d-none d-md-inline"></i> + Running Unit Tests + </a> + + </div> + <div class="col-12 col-md-6 text-center text-md-right"> + + </div> + </div> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/dev/code-repository.html ---------------------------------------------------------------------- diff --git a/dev/code-repository.html b/dev/code-repository.html new file mode 100644 index 0000000..80750a7 --- /dev/null +++ b/dev/code-repository.html @@ -0,0 +1,259 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>Code Repository · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + + <section> + <article> + <h1 class="text-center">Code Repository</h1> + + +<h2 id="git-repository">Git Repository</h2> + +<p>Cayenne uses Git for source code version control. “Master” writable repository is located here:<br /> +<a href="https://git-wip-us.apache.org/repos/asf/cayenne.git";>https://git-wip-us.apache.org/repos/asf/cayenne.git</a></p> + +<p>It can be cloned by anyone, and that’s where committers would ultimately push the code. We also have a GitHub read-only copy:<br /> +<a href="https://github.com/apache/cayenne";>https://github.com/apache/cayenne</a></p> + +<p>Feel free to fork and/or star Cayenne there.</p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="legacy-subversion-repository">Legacy Subversion Repository</h2> + +<p>Up to version 3.2M2 we used Subversion. For archival purposes SVN repository is still available +in a read-only mode:<br /> +<a href="https://svn.apache.org/repos/asf/cayenne/main/";>https://svn.apache.org/repos/asf/cayenne/main/</a></p> + +<p>Note that it contains branches and tags for releases prior to 3.0, that are not present in Git. So if you are looking for those older releases, you will have to use SVN.</p> + + </article> + </section> + + + <div class="pb-3"></div> + <div class="row"> + <div class="col-12 col-md-6 text-center text-md-left"> + + <a class="btn btn-link" href='/dev/how_development_happens.html'> + <span class="d-block d-md-none text-muted">Prev: </span> + <i class="small fa fa-chevron-left mr-3l2 d-none d-md-inline"></i> + How development happens + </a> + + </div> + <div class="col-12 col-md-6 text-center text-md-right"> + + <a class="btn btn-link" href='/dev/eclipse.html'> + <span class="d-block d-md-none text-muted">Next: </span> + Working with Cayenne code in Eclipse + <i class="small fa fa-chevron-right ml-3l2 d-none d-md-inline"></i> + </a> + + </div> + </div> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/dev/eclipse.html ---------------------------------------------------------------------- diff --git a/dev/eclipse.html b/dev/eclipse.html new file mode 100644 index 0000000..b2c5111 --- /dev/null +++ b/dev/eclipse.html @@ -0,0 +1,246 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>Working with Cayenne code in Eclipse · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + + <section> + <article> + <h1 class="text-center">Working with Cayenne code in Eclipse</h1> + <ul> +<li>Get code from Git and <a href="building-cayenne.html">build it from command line</a> +to seed the local repository.</li> +<li>Create a workspace outside of the main checkout folder.</li> +<li>Install <a href="http://www.sonatype.org/m2eclipse/";>Maven2 Eclipse plugin</a></li> +<li>Install any other plugins that you would normally use.</li> +<li>Go to “File > Import … > Existing Maven Projects”, and import the projects that you want.</li> +</ul> + + </article> + </section> + + + <div class="pb-3"></div> + <div class="row"> + <div class="col-12 col-md-6 text-center text-md-left"> + + <a class="btn btn-link" href='/dev/code-repository.html'> + <span class="d-block d-md-none text-muted">Prev: </span> + <i class="small fa fa-chevron-left mr-3l2 d-none d-md-inline"></i> + Code Repository + </a> + + </div> + <div class="col-12 col-md-6 text-center text-md-right"> + + <a class="btn btn-link" href='/dev/building-cayenne.html'> + <span class="d-block d-md-none text-muted">Next: </span> + Building Cayenne + <i class="small fa fa-chevron-right ml-3l2 d-none d-md-inline"></i> + </a> + + </div> + </div> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/e9062ca0/dev/how_development_happens.html ---------------------------------------------------------------------- diff --git a/dev/how_development_happens.html b/dev/how_development_happens.html new file mode 100644 index 0000000..c226594 --- /dev/null +++ b/dev/how_development_happens.html @@ -0,0 +1,284 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3"> + <link rel="shortcut icon" href="/favicon.ico" /> + <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144-precomposed.png" sizes="144x144" /> + <link rel="stylesheet" href="http://cayenne.apache.org/css/styles-452af12eaa.css"/> + <script src="http://cayenne.apache.org/js/bundle-bcaaf59313.js";></script> + <title>How development happens · Apache Cayenne</title> + </head> + <body> +<header class="page-header"> + <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation"> + <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0"> + <img class="mh-26px mr-1" src="/img/feather-641aa69d09.svg" /> + <li class="breadcrumb-item dropdown"> + <a class="dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache Software Foundation</a> + <div class="dropdown-menu" aria-labelledby="navbarDropdown"> + <a class="dropdown-item" href="http://www.apache.org";>Apache Homepage</a> + <a class="dropdown-item" href="http://www.apache.org/licenses/";>License</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> + <a class="dropdown-item" href="http://www.apache.org/foundation/thanks.html";>Thanks</a> + <a class="dropdown-item" href="http://www.apache.org/security/";>Security</a> + </div> + </li> + <li class="breadcrumb-item d-none d-lg-inline-block">Apache Cayenne</li> + </ul> + </nav> + <nav class="navbar navbar-expand-lg navbar-dark bg-primary"> + <div class="container"> + <a class="navbar-brand" href="http://cayenne.apache.org/";> + <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" /> + </a> + <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="mainMenu"> + <ul class="navbar-nav mt-3 mt-lg-0 mr-auto"> + + <li class="nav-item"> + <a class="nav-link" href="/download/">DOWNLOAD</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/docs/">DOCUMENTATION</a> + </li> + + <li class="nav-item"> + <a class="nav-link" href="/about/support/">SUPPORT</a> + </li> + + </ul> + <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu"> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne";> + <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" /><span class="stargazers_count ml-1l2"></span></a> + </li> + <li class="nav-item d-flex"> + <a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne";> + <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" /> + </a> + </li> + </ul> + </div> + </div> + </nav> +</header> + + + + + <main class="container py-5"> + + <section> + <article> + <h1 class="text-center">How development happens</h1> + + +<p>There are several levels of access to the Cayenne project and source.</p> + +<ol> +<li>Documentation only access. Access to the Confluence system for creating +documentation means that these users are able to edit and create content +which then available on this web site and bundled with the download.</li> +<li>Committers have direct access to Git and are able to make changes to the +entire source repository.</li> +<li>Project Management Committee (PMC) members have further responsibility +for the project as a whole and for ensuring that releases meet all the +appropriate standards.</li> +<li>PMC Chair. This person has a leadership role in the project and has a +special responsibility to the Apache board.<br /> +For further details consult the official <a href="http://www.apache.org/foundation/how-it-works.html#roles";>Apache handbook</a> +.</li> +</ol> + +<p>In addition to the general Apache responsibilities, this is what is +expected of everyone with privileges within the Cayenne project.</p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="contribution">Contribution</h2> + +<p>Contribution to the project can take many forms. Updating documentation and +helping users on the mailing lists are just as important as writing code. +Everyone here is a volunteer, so quantity of effort is not the most +important factor. Help when you can, but let the rest of the community know +if you will be out of action for an extended period.</p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="mailing-lists">Mailing lists</h2> + +<p>Cayenne takes special pride in the support we give to users of the +software. That means being helpful to end users where you have the time and +the answers. Just as importantly, users look to the committers and PMC +members to set the tone of the mailing lists; keeping them friendly and +pleasant places to be for all users regardless of their English language +skills or technical experience. When things might go off the rails, a +gentle nudge back in the right direction is all that is needed.</p> + +<div class="pb-3"><!-- gap 3rem --></div> + +<h2 id="voting">Voting</h2> + +<p>Each release should be voted on by the committers and PMC members. Even +though committer votes cannot count officially by Apache rules, they will +be given serious consideration by the PMC members. Further voting details +are in the release pages of this site.</p> + + </article> + </section> + + + <div class="pb-3"></div> + <div class="row"> + <div class="col-12 col-md-6 text-center text-md-left"> + + </div> + <div class="col-12 col-md-6 text-center text-md-right"> + + <a class="btn btn-link" href='/dev/code-repository.html'> + <span class="d-block d-md-none text-muted">Next: </span> + Code Repository + <i class="small fa fa-chevron-right ml-3l2 d-none d-md-inline"></i> + </a> + + </div> + </div> + </main> + + +<footer class="bg-dark"> + <div class="footer-nav container text-center text-lg-left pb-3"> + <div class="row pt-5 pb-3"> + + <div class="col-sm-6 col-lg-3"> + <h4>About</h4> + <ul class="list-unstyled"> + + <li> + <a href="/why-cayenne.html">Why Cayenne?</a> + </li> + + <li> + <a href="/download/">Download</a> + </li> + + <li> + <a href="/success-stories.html">Success Stories</a> + </li> + + <li> + <a href="/about/support/">Support</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Documentation</h4> + <ul class="list-unstyled"> + + <li> + <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a> + </li> + + <li> + <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a> + </li> + + <li> + <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a> + </li> + + <li> + <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>Collaboration</h4> + <ul class="list-unstyled"> + + <li> + <a href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a> + </li> + + <li> + <a href="/mailing-lists.html">Mailing Lists</a> + </li> + + <li> + <a href="/dev/code-repository.html">Code Repository</a> + </li> + + <li> + <a href="/dev/">Developer Guide</a> + </li> + + <li> + <a href="/how-can-i-help.html">How can I help?</a> + </li> + + <li> + <a href="/contributors.html">Contributors</a> + </li> + + </ul> + </div> + + <div class="col-sm-6 col-lg-3"> + <h4>News</h4> + <ul class="list-multiline-items list-unstyled mb-0"> + + <li> + <time datetime="2017-11-20 12:00:00 +0300 +03" class="xsmall d-block">Nov 20, 2017</time> + <a href="/2017/11/cayenne-312-released.html">Cayenne 3.1.2 Released</a> + </li> + + <li> + <time datetime="2017-10-14 12:00:00 +0300 +03" class="xsmall d-block">Oct 14, 2017</time> + <a href="/2017/10/cayenne-41m1-released.html">Cayenne 4.1 Milestone 1 Released</a> + </li> + + <li> + <time datetime="2017-10-06 17:38:42 +0300 +03" class="xsmall d-block">Oct 06, 2017</time> + <a href="/2017/10/cayenne-40B2-released.html">Cayenne 4.0 Beta 2 Released</a> + </li> + + </ul> + <a class="btn-link text-uppercase xsmall" href="http://cayenne.apache.org/news";> + More news + <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i> + </a> + </div> + </div> + <hr class="mt-0 mb-3" /> + <p class="copy xsmall text-center mw-75 mx-auto mb-0"> + Copyright © 2001-2018 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation. <a href="http://cayenne.apache.org/privacy-policy.html";>Privacy policy</a>. + <img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" /> + </p> + </div> +</footer> + +<script> +(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ +(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), +m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) +})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + +ga('create', 'UA-7036673-1', 'auto'); +ga('send', 'pageview'); +</script> + + </body> +</html>
