first cut at actual content
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/0cffb1aa Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/0cffb1aa Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/0cffb1aa Branch: refs/heads/master Commit: 0cffb1aaac0e8fd7278e3c7af9bb439bfbe25061 Parents: 720c2ec Author: Andy Perlitch <[email protected]> Authored: Mon Sep 7 09:45:03 2015 -0700 Committer: Andy Perlitch <[email protected]> Committed: Mon Sep 7 09:46:41 2015 -0700 ---------------------------------------------------------------------- README.md | 18 +++++++++++++++++- gulpfile.js | 36 +++++++++-------------------------- navigation.js | 22 +++++++++++++++++++++ src/less/index.less | 3 +++ src/less/variables.less | 2 +- src/md/community.md | 21 ++++++++++++++++++++ src/md/docs.md | 3 +++ src/pages/community.html | 6 +++++- src/pages/docs.html | 6 +++++- src/pages/index.html | 38 ++++++++++++++++++++++++++++++++++--- src/partials/footer.handlebars | 27 ++++++++++++-------------- src/partials/header.handlebars | 36 +++++++++++++++++++++-------------- 12 files changed, 155 insertions(+), 63 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index fcc3f4b..23cf4ba 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,20 @@ Assuming you have a file called `src/md/example_markdown.md`, you could have thi {{> example_markdown}} {{> footer}} -``` \ No newline at end of file +``` + +Building +-------- +Requires nodejs and npm. +```bash +# install dependencies +npm install +# run gulp command +./node_modules/.bin/gulp +``` + +Developing +---------- + +When making changes to src files, you can run `grunt watch`, which will constantly build the project in the `/content` folder, +so you don't have to manually run `grunt` after every change \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/gulpfile.js ---------------------------------------------------------------------- diff --git a/gulpfile.js b/gulpfile.js index 2858de0..f7f4197 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -15,7 +15,10 @@ var BUILD_LOCATION = './content'; gulp.task('md2html', function() { return gulp.src('./src/md/*.md') .pipe(marked()) - .pipe(gulp.dest(TEMP_PARTIAL_LOCATION)); + .pipe(gulp.dest(TEMP_PARTIAL_LOCATION)) + .on('error', function(err) { + console.warn(err); + }); }); // Builds html files from src/pages @@ -27,34 +30,13 @@ gulp.task('html', ['md2html'], function() { batch: ['./src/partials', TEMP_PARTIAL_LOCATION] }; - - // Passed into every template for interpolation - var templateData = { - - // Nav elements - nav: [ - { id: 'index', label: 'Home', href: '/' }, - { id: 'community', label: 'Community', href: '/community.html' }, - { id: 'docs', label: 'Docs', href: '/docs.html' }, - { id: 'github', label: 'Github', items: [ - { label: 'Apex Core', href: 'https://github.com/apache/incubator-apex-core' }, - { label: 'Apex Malhar', href: 'https://github.com/apache/incubator-apex-malhar' } - ] }, - { id: 'apache', label: 'Apache', items: [ - { label: 'Status Page', href: 'http://incubator.apache.org/projects/apex.html' }, - { label: 'Apache Foundation', href: 'http://www.apache.org/foundation/how-it-works.html' }, - { label: 'Apache License', href: 'http://www.apache.org/licenses/' }, - { label: 'Sponsorship', href: 'http://www.apache.org/foundation/sponsorship.html' }, - { label: 'Thanks', href: 'http://www.apache.org/foundation/thanks.html' } - ]} - ] - - }; - // Render the files in pages gulp.src('./src/pages/*.html') - .pipe(handlebars(templateData, options)) - .pipe(gulp.dest(BUILD_LOCATION)); + .pipe(handlebars({ nav: require('./navigation') }, options)) + .pipe(gulp.dest(BUILD_LOCATION)) + .on('error', function(err) { + console.warn(err); + }); }); http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/navigation.js ---------------------------------------------------------------------- diff --git a/navigation.js b/navigation.js new file mode 100644 index 0000000..5eb447c --- /dev/null +++ b/navigation.js @@ -0,0 +1,22 @@ +'use strict'; + +/** + * This array generates the top navigation + */ + +exports = module.exports = [ + { id: 'index', label: 'Home', href: '/' }, + { id: 'community', label: 'Community', href: '/community.html' }, + { id: 'docs', label: 'Docs', href: '/docs.html' }, + { id: 'github', label: 'Github', items: [ + { label: 'Apex Core', href: 'https://github.com/apache/incubator-apex-core' }, + { label: 'Apex Malhar', href: 'https://github.com/apache/incubator-apex-malhar' } + ] }, + { id: 'apache', label: 'Apache', items: [ + { label: 'Status Page', href: 'http://incubator.apache.org/projects/apex.html' }, + { label: 'Apache Foundation', href: 'http://www.apache.org/foundation/how-it-works.html' }, + { label: 'Apache License', href: 'http://www.apache.org/licenses/' }, + { label: 'Sponsorship', href: 'http://www.apache.org/foundation/sponsorship.html' }, + { label: 'Thanks', href: 'http://www.apache.org/foundation/thanks.html' } + ]} +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/less/index.less ---------------------------------------------------------------------- diff --git a/src/less/index.less b/src/less/index.less index b247158..2982058 100644 --- a/src/less/index.less +++ b/src/less/index.less @@ -2,4 +2,7 @@ margin-top:-10px; background-color: @brand-primary; color: white; + h1 small { + color: rgba(255,255,255,0.5); + } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/less/variables.less ---------------------------------------------------------------------- diff --git a/src/less/variables.less b/src/less/variables.less index 39e05ae..01c08ee 100644 --- a/src/less/variables.less +++ b/src/less/variables.less @@ -14,7 +14,7 @@ @gray-light: lighten(@gray-base, 46.7%); // #777 @gray-lighter: lighten(@gray-base, 93.5%); // #eee -@brand-primary: darken(#4034A9, 6.5%); // #337ab7 +@brand-primary: #408547; // #337ab7 @brand-success: #5cb85c; @brand-info: #5bc0de; @brand-warning: #f0ad4e; http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/md/community.md ---------------------------------------------------------------------- diff --git a/src/md/community.md b/src/md/community.md new file mode 100644 index 0000000..b03461f --- /dev/null +++ b/src/md/community.md @@ -0,0 +1,21 @@ +# Community + +## Mailing Lists + +The following mailing lists can be used to get help with Apex. + +- [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-apex-users/) is for usage questions, help, and announcements. [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/incubator-apex-users/) +- [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-apex-dev/) is for people who want to contribute code to apex. [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/incubator-apex-dev/) +- [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-apex-commits/) is for commit messages and patches to apex. [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/incubator-apex-commits/) + + +## Github Repositories + +The Apex Project is made up of two repositories: + +- [Apex Core](https://github.com/apache/incubator-apex-core) - The core of the Apex platform. +- [Apex Malhar](https://github.com/apache/incubator-apex-malhar) - Community-driven set of open-source "operators" and utilities for use in your Apex applications. + +## Issue Tracking + +[Apex JIRA](https://malhar.atlassian.net/projects/APEX/issues) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/md/docs.md ---------------------------------------------------------------------- diff --git a/src/md/docs.md b/src/md/docs.md new file mode 100644 index 0000000..7ee48e1 --- /dev/null +++ b/src/md/docs.md @@ -0,0 +1,3 @@ +# Documentation + +Docs are coming soon! \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/pages/community.html ---------------------------------------------------------------------- diff --git a/src/pages/community.html b/src/pages/community.html index df5b817..b230c5d 100644 --- a/src/pages/community.html +++ b/src/pages/community.html @@ -1,5 +1,9 @@ {{> header}} -Community +<div class="container"> + + {{> community}} + +</div> {{> footer}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/pages/docs.html ---------------------------------------------------------------------- diff --git a/src/pages/docs.html b/src/pages/docs.html index ef1eead..33a54c1 100644 --- a/src/pages/docs.html +++ b/src/pages/docs.html @@ -1,5 +1,9 @@ {{> header}} -Documentation coming soon! +<div class="container"> + + {{> docs}} + +</div> {{> footer}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/pages/index.html ---------------------------------------------------------------------- diff --git a/src/pages/index.html b/src/pages/index.html index 220b66b..c9744e2 100644 --- a/src/pages/index.html +++ b/src/pages/index.html @@ -3,9 +3,41 @@ <!-- Main jumbotron for a primary marketing message or call to action --> <div class="jumbotron"> <div class="container"> - <h1>Hello, world!</h1> - <p>This is a template for a simple marketing or informational website. It includes a large callout called a jumbotron and three supporting pieces of content. Use it as a starting point to create something more unique.</p> - <p><a class="btn btn-primary btn-lg" href="#" role="button">Learn more »</a></p> + <h1>Apache Apex <small>(incubating)</small></h1> + <p>An enterprise grade native YARN big data-in-motion platform that unifies stream processing as well as batch processing.</p> + <p> + <a class="btn btn-info btn-lg" href="http://incubator.apache.org/projects/apex.html" role="button">Incubation Status Page</a> + <a class="btn btn-info btn-lg" href="https://github.com/apache/incubator-apex-core" role="button">Github</a> + </p> + </div> +</div> + +<div class="container"> + <!-- Example row of columns --> + <div class="row"> + <div class="col-md-4"> + <h2>Highly Scalable</h2> + <p> + The Apex engine is capable of processing billions of events per second using minimal resources, + and outperforms all other streaming solutions by orders of magnitude. + </p> + <p><a class="btn btn-secondary" href="#" role="button">View details »</a></p> + </div> + <div class="col-md-4"> + <h2>Fault Tolerant</h2> + <p> + Recovery mechanisms are built-in to the Apex platform, so you don't need to write application code to ensure fault-tolerance. + </p> + <p><a class="btn btn-secondary" href="#" role="button">View details »</a></p> + </div> + <div class="col-md-4"> + <h2>Easy to Use</h2> + <p> + The Apex platform has a simple programming paradigm, you only need to worry about writing your own business logic. + Then use simple attributes to fine-tune your application. + </p> + <p><a class="btn btn-secondary" href="#" role="button">View details »</a></p> + </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/partials/footer.handlebars ---------------------------------------------------------------------- diff --git a/src/partials/footer.handlebars b/src/partials/footer.handlebars index 8f4cf7a..118b537 100644 --- a/src/partials/footer.handlebars +++ b/src/partials/footer.handlebars @@ -1,17 +1,14 @@ - <hr> - - <footer> - <p>© Company 2014</p> - </footer> - </div> <!-- /container --> - - - <!-- Bootstrap core JavaScript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script> - <script>window.jQuery || document.write('<script src="../../assets/js/vendor/jquery.min.js"><\/script>')</script> - <script src="../../dist/js/bootstrap.min.js"></script> + <hr> + <div class="container"> + <footer> + <p>© Apache Software Foundation 2015</p> + </footer> + </div> <!-- /container --> + + <!-- Placed at the end of the document so the pages load faster --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script> + <script src="/js/bootstrap.min.js"></script> -</body></html> \ No newline at end of file +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/0cffb1aa/src/partials/header.handlebars ---------------------------------------------------------------------- diff --git a/src/partials/header.handlebars b/src/partials/header.handlebars index 37f0ff9..0e4d6db 100644 --- a/src/partials/header.handlebars +++ b/src/partials/header.handlebars @@ -16,18 +16,26 @@ </head> <body> - - <nav class="navbar navbar-inverse navbar-static-top"> - <a class="navbar-brand" href="#">Apache Apex <small>(incubating)</small></a> - <ul class="nav nav-pills"> - <li class="nav-item"> - <a class="nav-link" href="community.html">Community</a> - </li> - <li class="nav-item"> - <a class="nav-link" href="#">About</a> - </li> - <li class="nav-item"> - <a class="nav-link" href="#">Contact</a> - </li> - </ul> + <nav class="navbar navbar-static-top" id="main-nav"> + <div class="container"> + <a class="navbar-brand" href="#">Apache Apex <small>(incubating)</small></a> + <ul class="nav nav-pills navbar-right"> + {{#each nav}} + {{#if items}} + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">{{label}}<b class="caret"></b></a> + <ul class="dropdown-menu"> + {{#each items}} + <li><a href="{{href}}">{{label}}</a></li> + {{/each}} + </ul> + </li> + {{else}} + <li class="nav-item"> + <a class="nav-link" href="{{href}}">{{label}}</a> + </li> + {{/if}} + {{/each}} + </ul> + </div> </nav> \ No newline at end of file
