Repository: incubator-gearpump Updated Branches: refs/heads/master 56ac28642 -> 757dd367e
fix links in documentation and comments Author: manuzhang <[email protected]> Closes #42 from manuzhang/fix_doc. Project: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/commit/757dd367 Tree: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/tree/757dd367 Diff: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/diff/757dd367 Branch: refs/heads/master Commit: 757dd367ecdfc00aad7aa37c17333e74f6ae12c1 Parents: 56ac286 Author: manuzhang <[email protected]> Authored: Tue Jun 21 09:09:55 2016 +0800 Committer: manuzhang <[email protected]> Committed: Tue Jun 21 09:09:55 2016 +0800 ---------------------------------------------------------------------- CONTRIBUTING.md | 2 +- README.md | 4 +- conf/gear.conf | 2 +- core/src/main/resources/geardefault.conf | 2 +- docs/_config.yml | 3 - docs/_layouts/global.html | 6 +- docs/about.md | 34 ----------- docs/dev-non-streaming-example.md | 2 +- docs/dev-write-1st-app.md | 2 +- docs/gearpump-internals.md | 4 +- docs/get-gearpump-distribution.md | 2 +- docs/how-to-contribute.md | 63 -------------------- experiments/cgroup/README.md | 2 +- .../cluster/worker/CGroupProcessLauncher.scala | 3 +- services/dashboard/views/landing/header.js | 4 +- ...CloudFoundryUAAOAuth2AuthenticatorSpec.scala | 2 +- .../oauth2/GoogleOAuth2AuthenticatorSpec.scala | 2 +- 17 files changed, 19 insertions(+), 120 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index adaa313..9fd3859 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -267,7 +267,7 @@ To build Gearpump document use <a name="ide-setup"></a> ## IDE setup IDE environment can be set up on either Windows, Linux and Mac platform. You can choose the one you prefer. -The IDE setup guide can be found at [Gearpump website](http://www.gearpump.io/releases/latest/dev-ide-setup.html). +The IDE setup guide can be found at [Gearpump website](http://gearpump.apache.org/releases/latest/dev-ide-setup.html). It is highly recommended to perform [package build](#build) before IDE setup. http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 0c0ff27..2ea1e8c 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ For steps to reproduce the performance test, please check [Performance benchmark * How to [Develop your first application](http://gearpump.apache.org/releases/latest/dev-write-1st-app.html) * How to [Submit your first application](http://gearpump.apache.org/releases/latest/submit-your-1st-application.html) * Explore the [Maven dependencies](http://gearpump.apache.org/releases/latest/maven-setting.html) -* Explore the [Document site](http://gearpump.io) -* Explore the [User List](https://groups.google.com/forum/#!forum/gearpump-user) +* Explore the [Document site](http://gearpump.apache.org) +* Explore the [User Mailing List](http://mail-archives.apache.org/mod_mbox/incubator-gearpump-user/) * Report an [issue](https://issues.apache.org/jira/browse/GEARPUMP) ## How to Build http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/conf/gear.conf ---------------------------------------------------------------------- diff --git a/conf/gear.conf b/conf/gear.conf index 69ff213..fa0a3e9 100644 --- a/conf/gear.conf +++ b/conf/gear.conf @@ -40,7 +40,7 @@ gearpump { ## Before enable it, you should also make sure: ## 1. Linux version (>= 2.6.18) ## 2. Have installed cgroup (check the file's existence:/proc/cgroups) - ## You can get more information from http://gearpump.io + ## You can get more information from http://gearpump.apache.org/releases/latest/deployment-resource-isolation.html ## ## For cgroup root, it represents the root node in CGroup's hierarchythe. ## It's full path in local file system is "${cpu_mount_point} + root". http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/core/src/main/resources/geardefault.conf ---------------------------------------------------------------------- diff --git a/core/src/main/resources/geardefault.conf b/core/src/main/resources/geardefault.conf index bb96718..e4aaec6 100644 --- a/core/src/main/resources/geardefault.conf +++ b/core/src/main/resources/geardefault.conf @@ -62,7 +62,7 @@ gearpump { ## Before enable it, you should also make sure: ## 1. Linux version (>= 2.6.18) ## 2. Have installed cgroup (check the file's existence:/proc/cgroups) - ## You can get more information from http://gearpump.io + ## You can get more information from http://gearpump.apache.org/releases/latest/deployment-resource-isolation.html ## ## For cgroup root, it represents the root node in CGroup's hierarchythe. ## It's full path in local file system is "${cpu_mount_point} + root". http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/_config.yml ---------------------------------------------------------------------- diff --git a/docs/_config.yml b/docs/_config.yml index 18d959b..952be52 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -19,6 +19,3 @@ exclude: GEARPUMP_VERSION: 0.8.1-SNAPSHOT SCALA_BINARY_VERSION: "2.11" SCALA_VERSION: "2.11.8" -GEARPUMP_ISSUE_TRACKER_URL: https://github.com/gearpump/gearpump/issues -GEARPUMP_GITHUB_URL: https://github.com/gearpump/gearpump -GEARPUMP_EXAMPLES_URL: https://github.com/gearpump/gearpump-examples http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/_layouts/global.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/global.html b/docs/_layouts/global.html index d5c7a20..84c4b84 100644 --- a/docs/_layouts/global.html +++ b/docs/_layouts/global.html @@ -50,7 +50,7 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="http://gearpump.io";>Gearpump + <a class="navbar-brand" href="http://gearpump.apache.org";>Gearpump <span class="label label-primary" style="font-size: .6em">{{site.GEARPUMP_VERSION}}</span> </a> </div> @@ -122,9 +122,7 @@ <li><a href="how-to-contribute.html">How to Contribute</a></li> <li><a href="coding-style.html">Coding Style</a></li> <li class="divider"></li> - <li><a href="faq.html">FAQ</a> - <li> - <li><a href="about.html">About</a></li> + <li><a href="faq.html">FAQ</a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/about.md ---------------------------------------------------------------------- diff --git a/docs/about.md b/docs/about.md deleted file mode 100644 index a4f3ebf..0000000 --- a/docs/about.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: global -title: About ---- -### Who are we? - -We are a group of streaming guys from Intel. - -### User List - -We have a user mail list at: [User Mail List](https://groups.google.com/forum/#!forum/gearpump-user) - -### Submit an issue - -Please submit new issue to [https://github.com/gearpump/gearpump/issues](https://github.com/gearpump/gearpump/issues) - -### Make code contribution - -Contributions are warmly welcome! To contribute to Gearpump source code, please make a PR against [https://github.com/gearpump/gearpump/pulls](https://github.com/gearpump/gearpump/pulls) - -To contribute to the contents in this site, make a PR to [https://github.com/gearpump/gearpump.github.io](https://github.com/gearpump/gearpump.github.io) - -### More Technical Support - -For business cooperation and support, please contact <[email protected]> <[email protected]> <[email protected]> - -### License - -The source tree under [http://github.com/gearpump/gearpump](http://github.com/gearpump/gearpump) is -Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 - -### Acknowledgement - -The netty transport code work is based on [Apache Storm](http://storm.apache.org/). Thanks Apache Storm contributors. http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/dev-non-streaming-example.md ---------------------------------------------------------------------- diff --git a/docs/dev-non-streaming-example.md b/docs/dev-non-streaming-example.md index 8b859dc..50ad131 100644 --- a/docs/dev-non-streaming-example.md +++ b/docs/dev-non-streaming-example.md @@ -3,7 +3,7 @@ layout: global title: Gearpump Non-Streaming Example --- -We'll use [Distributed Shell](https://github.com/gearpump/gearpump/tree/master/examples/distributedshell/src/main/scala/org.apache.gearpump/examples/distributedshell) as an example to illustrate how to do that. +We'll use [Distributed Shell](https://github.com/apache/incubator-gearpump/blob/master/examples/distributedshell) as an example to illustrate how to do that. What Distributed Shell do is that user send a shell command to the cluster and the command will the executed on each node, then the result will be return to user. http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/dev-write-1st-app.md ---------------------------------------------------------------------- diff --git a/docs/dev-write-1st-app.md b/docs/dev-write-1st-app.md index e125f3d..0df19be 100644 --- a/docs/dev-write-1st-app.md +++ b/docs/dev-write-1st-app.md @@ -5,7 +5,7 @@ title: Write Your 1st Gearpump App description: Write Your 1st Gearpump App --- -We'll use [wordcount](https://github.com/gearpump/gearpump/blob/master/examples/streaming/wordcount/src/main/scala/org.apache.gearpump/streaming/examples/wordcount/) as an example to illustrate how to write Gearpump applications. +We'll use [wordcount](https://github.com/apache/incubator-gearpump/tree/master/examples/streaming/wordcount/src/main/scala/org/apache/gearpump/streaming/examples/wordcount) as an example to illustrate how to write Gearpump applications. ### Maven/Sbt Settings http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/gearpump-internals.md ---------------------------------------------------------------------- diff --git a/docs/gearpump-internals.md b/docs/gearpump-internals.md index bdfecbe..ba80072 100644 --- a/docs/gearpump-internals.md +++ b/docs/gearpump-internals.md @@ -202,12 +202,12 @@ Figure: Dynamic Graph, Attach, Replace, and Remove ## At least once message delivery and Kafka The Kafka source example project and tutorials can be found at: -- [Kafka connector example project](https://github.com/gearpump/gearpump/tree/master/examples/streaming/kafka) +- [Kafka connector example project](https://github.com/apache/incubator-gearpump/tree/master/examples/streaming/kafka) - [Connect with Kafka source](dev-connectors.html) In this doc, we will talk about how the at least once message delivery works. -We will use the WordCount example of [source tree](https://github.com/gearpump/gearpump/tree/master/examples/streaming/kafka) to illustrate. +We will use the WordCount example of [source tree](https://github.com/apache/incubator-gearpump/tree/master/examples/streaming/kafka) to illustrate. ### How the kafka WordCount DAG looks like: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/get-gearpump-distribution.md ---------------------------------------------------------------------- diff --git a/docs/get-gearpump-distribution.md b/docs/get-gearpump-distribution.md index aab0514..381d248 100644 --- a/docs/get-gearpump-distribution.md +++ b/docs/get-gearpump-distribution.md @@ -21,7 +21,7 @@ If you choose to build the package from source code yourself, you can follow the 1). Clone the Gearpump repository ```bash - git clone https://github.com/gearpump/gearpump.git + git clone https://github.com/apache/incubator-gearpump.git cd gearpump ``` http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/docs/how-to-contribute.md ---------------------------------------------------------------------- diff --git a/docs/how-to-contribute.md b/docs/how-to-contribute.md deleted file mode 100644 index e9e33c1..0000000 --- a/docs/how-to-contribute.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: global -title: How to contribute ---- - -## Contributions Welcome! -Gearpump is developed by an open and friendly community. Everybody is cordially welcome to join the community and contribute to Gearpump. There are several ways to interact with the community and to contribute to Gearpump including asking questions, filing bug reports, implementing new use cases, proposing new features, joining discussions on the mailing lists, contributing code or documentation, improving the website, or testing release candidates. - -### Ask questions! - -The Gearpump community is eager to help and to answer your questions. We have a [user mailing list](https://groups.google.com/forum/#!forum/gearpump-user). - -### File a bug report - -Please let us know if you experienced a problem with Gearpump and file a bug report. Open [Gearpumpâs Issue Tracker](https://github.com/gearpump/gearpump/issues) and click on the green *New Issue* button at the top right. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem. Thank you very much. - -### Propose an improvement or a new feature - -Our community is constantly looking for feedback to improve Gearpump. If you have an idea how to improve Gearpump or have a new feature in mind that would be beneficial for Gearpump users, please open an issue in [Gearpumpâs Issue Tracker](https://github.com/gearpump/gearpump/issues). The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons: - -* It ensures your requirements are met when the improvement or feature is implemented. -* It helps to estimate the effort and to design a solution that addresses your needs. -* It allow for constructive discussions that might arise around this issue. -* Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the Contribute code guide in this case as well. - -### Test a release candidate - -Gearpump is continuously improved by its active community. Every few weeks, we release a new version of Gearpump with bug fixes, improvements, and new features. Release testing is a big effort if done by a small group of people but can be easily scaled out to more people. The Gearpump community encourages everybody to participate in the testing of a release candidate. By testing a release candidate, you can ensure that the next Gearpump release is working properly for your setup and help to improve the quality of releases. - -### Contribute code - -Gearpump is maintained, improved, and extended by code contributions of volunteers. The Gearpump community encourages anybody to contribute source code. - -### Looking for an issue to work on? -We maintain a list of all known bugs, proposed improvements and suggested features in [Gearpumpâs Issue Tracker](https://github.com/gearpump/gearpump/issues). Please have a look at the list, if you are looking for an issue to work on. Feel free to ask questions about issues that you would be interested in working on. - -### Contribute documentation - -Good documentation is crucial for any kind of software. This is especially true for sophisticated software systems such as distributed data processing engines like Gearpump. The Gearpump community aims to provide concise, precise, and complete documentation and welcomes any contribution to improve Gearpumpâs documentation. - -Please report missing, incorrect, or out-dated documentation as an issue. -Gearpumpâs documentation is written in Markdown and located in the `docs` folder in Gearpumpâs source code repository. - -### Improve the website - -The Gearpump website presents Gearpump and its community. It serves several purposes including: - -* Informing visitors about Gearpump and its features. -* Encouraging visitors to download and use Gearpump. -* Encouraging visitors to engage with the community. - -We welcome any contribution to improve our website. - -Please open an issue at [Gearpump Website Issue Tracker](https://github.com/gearpump/gearpump.github.io/issues) if you think our website could be improved. - -### More ways to contribute⦠- -There are many more ways to contribute to the Gearpump community. For example you can - -* give a talk about Gearpump and tell others how you use it. -* organize a local Meetup or user group. -* talk to people about Gearpump. -* ⦠http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/experiments/cgroup/README.md ---------------------------------------------------------------------- diff --git a/experiments/cgroup/README.md b/experiments/cgroup/README.md index ca839cd..0ae12a5 100644 --- a/experiments/cgroup/README.md +++ b/experiments/cgroup/README.md @@ -1 +1 @@ -Please see http://gearpump.io for documentation on Cgroup. \ No newline at end of file +Please see http://gearpump.apache.org/releases/latest/deployment-resource-isolation.html for documentation on Cgroup. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/experiments/cgroup/src/main/scala/org/apache/gearpump/cluster/worker/CGroupProcessLauncher.scala ---------------------------------------------------------------------- diff --git a/experiments/cgroup/src/main/scala/org/apache/gearpump/cluster/worker/CGroupProcessLauncher.scala b/experiments/cgroup/src/main/scala/org/apache/gearpump/cluster/worker/CGroupProcessLauncher.scala index e6e25c3..74a4047 100644 --- a/experiments/cgroup/src/main/scala/org/apache/gearpump/cluster/worker/CGroupProcessLauncher.scala +++ b/experiments/cgroup/src/main/scala/org/apache/gearpump/cluster/worker/CGroupProcessLauncher.scala @@ -28,7 +28,8 @@ import org.apache.gearpump.util.{ProcessLogRedirector, RichProcess} /** * CGroupProcessLauncher is used to launch a process for Executor with CGroup. - * For more details, please refer http://gearpump.io + * For more details, please refer to + * http://gearpump.apache.org/releases/latest/deployment-resource-isolation.html */ class CGroupProcessLauncher(val config: Config) extends ExecutorProcessLauncher { private val APP_MASTER = -1 http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/services/dashboard/views/landing/header.js ---------------------------------------------------------------------- diff --git a/services/dashboard/views/landing/header.js b/services/dashboard/views/landing/header.js index 617dfda..22c39d7 100644 --- a/services/dashboard/views/landing/header.js +++ b/services/dashboard/views/landing/header.js @@ -23,8 +23,8 @@ angular.module('dashboard') $scope.userMenuItems = [ {text: 'Sign Out', href: conf.loginUrl, icon: 'glyphicon glyphicon-off'}, {isDivider: true}, - {text: 'Documents', href: '//gearpump.io', icon: 'fa fa-book'}, - {text: 'GitHub', href: '//github.com/gearpump/gearpump', icon: 'fa fa-github'} + {text: 'Documents', href: '//gearpump.apache.org', icon: 'fa fa-book'}, + {text: 'GitHub', href: '//github.com/apache/incubator-gearpump', icon: 'fa fa-github'} ]; $scope.version = 'beta'; http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/CloudFoundryUAAOAuth2AuthenticatorSpec.scala ---------------------------------------------------------------------- diff --git a/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/CloudFoundryUAAOAuth2AuthenticatorSpec.scala b/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/CloudFoundryUAAOAuth2AuthenticatorSpec.scala index fef581e..2c163bb 100644 --- a/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/CloudFoundryUAAOAuth2AuthenticatorSpec.scala +++ b/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/CloudFoundryUAAOAuth2AuthenticatorSpec.scala @@ -74,7 +74,7 @@ class CloudFoundryUAAOAuth2AuthenticatorSpec extends FlatSpec with ScalatestRout val code = Map("code" -> "QGGVeA") val accessToken = "e2922002-0218-4513-a62d-1da2ba64ee4c" val refreshToken = "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2Nm" - val mail = "[email protected]" + val mail = "[email protected]" def accessTokenEndpoint(request: HttpRequest): HttpResponse = { assert(request.getHeader("Authorization").get.value() == http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/757dd367/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/GoogleOAuth2AuthenticatorSpec.scala ---------------------------------------------------------------------- diff --git a/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/GoogleOAuth2AuthenticatorSpec.scala b/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/GoogleOAuth2AuthenticatorSpec.scala index 610f0c7..82cb276 100644 --- a/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/GoogleOAuth2AuthenticatorSpec.scala +++ b/services/jvm/src/test/scala/org/apache/gearpump/services/security/oauth2/GoogleOAuth2AuthenticatorSpec.scala @@ -72,7 +72,7 @@ class GoogleOAuth2AuthenticatorSpec extends FlatSpec with ScalatestRouteTest { val code = Map("code" -> "4/PME0pfxjiBA42SukR-OTGl7fpFzTWzvZPf1TbkpXL4M#") val accessToken = "e2922002-0218-4513-a62d-1da2ba64ee4c" val refreshToken = "eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2Nm" - val mail = "[email protected]" + val mail = "[email protected]" def accessTokenEndpoint(request: HttpRequest): HttpResponse = {
