You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by da...@apache.org on 2016/09/30 19:20:23 UTC
[1/2] apex-malhar git commit: Removed deployment documentation as it
is included in the release documentation
Repository: apex-malhar
Updated Branches:
refs/heads/master 139d89fd3 -> 58201fbf9
Removed deployment documentation as it is included in the release documentation
Project: http://git-wip-us.apache.org/repos/asf/apex-malhar/repo
Commit: http://git-wip-us.apache.org/repos/asf/apex-malhar/commit/eb624518
Tree: http://git-wip-us.apache.org/repos/asf/apex-malhar/tree/eb624518
Diff: http://git-wip-us.apache.org/repos/asf/apex-malhar/diff/eb624518
Branch: refs/heads/master
Commit: eb62451875ad1dbb5008124f45475284ca85ce55
Parents: 139d89f
Author: Pramod Immaneni <pr...@datatorrent.com>
Authored: Sat Jul 9 12:36:45 2016 -0700
Committer: Thomas Weise <th...@apache.org>
Committed: Fri Sep 30 10:59:43 2016 -0700
----------------------------------------------------------------------
docs/README.md | 24 ------------------------
1 file changed, 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/eb624518/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index a001a1d..ec669bc 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -19,27 +19,3 @@ For additional details see [writing your docs](http://www.mkdocs.org/user-guide/
## Site Configuration
Guides on applying site-wide [configuration](http://www.mkdocs.org/user-guide/configuration/) and [themeing](http://www.mkdocs.org/user-guide/styling-your-docs/) are available on the MkDocs site.
-
-## Deployment
-
-Deployment is done in two steps. First all documentation is statically generatd into HTML files and then it is deployed to the apex website. For more details on how conversion to HTML works see [MkDocs documentation](http://www.mkdocs.org/).
-
-1. Go to release branch of the repository and execute the following command to build the docs:
-
-```bash
-# set project version
-APEX_MALHAR_VERSION=3.4
-
-# build docs under site foolder
-mkdocs build --clean
-
-# copy docs from site into target folder on apex-site
-cd ../incubator-apex-site
-git checkout asf-site
-cp -r ../incubator-apex-malhar/site docs/malhar-${APEX_MALHAR_VERSION}
-git add -A
-git commit -m "Adding apex-${APEX_MALHAR_VERSION} documentation"
-git push
-```
-
-2. Go to [apex-site repository](https://github.com/apache/incubator-apex-site#contributing) and add the new link to the [docs.md](https://github.com/apache/incubator-apex-site/blob/master/src/md/docs.md) and follow committer steps to commit and push these changes, and deploy the site.
[2/2] apex-malhar git commit: Update README.md closes #337
Posted by da...@apache.org.
Update README.md
closes #337
Project: http://git-wip-us.apache.org/repos/asf/apex-malhar/repo
Commit: http://git-wip-us.apache.org/repos/asf/apex-malhar/commit/58201fbf
Tree: http://git-wip-us.apache.org/repos/asf/apex-malhar/tree/58201fbf
Diff: http://git-wip-us.apache.org/repos/asf/apex-malhar/diff/58201fbf
Branch: refs/heads/master
Commit: 58201fbf9b6685f8f3f0e27b0a8fb7fabba324cd
Parents: eb62451
Author: Thomas Weise <th...@apache.org>
Authored: Fri Sep 30 11:00:11 2016 -0700
Committer: Thomas Weise <th...@apache.org>
Committed: Fri Sep 30 11:00:11 2016 -0700
----------------------------------------------------------------------
README.md | 23 +++++------------------
1 file changed, 5 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/58201fbf/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index e42c032..4781031 100644
--- a/README.md
+++ b/README.md
@@ -6,17 +6,17 @@ Malhar repository contains open source operator and codec library that can be us
Contributing
------------
-This project welcomes new contributors. If you would like to help make Malhar better by adding new features, enhancing existing features, or fixing bugs, check out the [contributing guidelines](http://apex.apache.org/contributing.html).
+This project welcomes new contributors. If you would like to help by adding new features, enhancing existing features, or fixing bugs, check out the [contributing guidelines](http://apex.apache.org/contributing.html) and guidelines for [contributing to the operator library](http://apex.apache.org/malhar-contributing.html).
You acknowledge that your submissions to this repository are made pursuant the terms of the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html) and constitute "Contributions," as defined therein, and you represent and warrant that you have the right and authority to do so.
+You can submit new issues and track the progress of existing issues at https://issues.apache.org/jira/browse/APEXMALHAR
+
Documentation
-------------
Please visit the [documentation section](http://apex.apache.org/docs.html).
-Documentation build and hosting process is explained in [docs README](docs/README.md).
-
Discussion group
--------------------
@@ -27,25 +27,12 @@ Building the project
The project uses Maven for the build. Run
```
-mvn install
+mvn install -DskipTests
```
The code depends on the Apex API, which is available in the Maven Central Repository. Individual modules such as library can be built independently by changing directory to the module and running maven there.
-Multiple [demo applications](demos/src/main/java/com/datatorrent/demos) are provided to showcase the Apex platform and application development process.
-
-Issue tracking
---------------------
-
-[JIRA](https://issues.apache.org/jira/browse/APEXMALHAR) issue tracking system is used for this project.
-You can submit new issues and track the progress of existing issues at https://issues.apache.org/jira/browse/APEXMALHAR
-
-Please include the JIRA ticket number into the commit messages. It will automatically add the commit message to the JIRA ticket(s) and help link the commit with the issue(s) being tracked for easy reference.
-An example commit might look like this:
-
- git commit -am "APEXMALHAR-1234 Task completed ahead of schedule"
-
-JIRA tickets should be resolved and fix version field set by the committer merging the pull request.
+Multiple [demo applications](demos/) are provided to showcase the Apex platform and application development process.
License
--------------------