You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@griffin.apache.org by gu...@apache.org on 2018/11/30 02:03:35 UTC
incubator-griffin git commit: doc improvement
Repository: incubator-griffin
Updated Branches:
refs/heads/master 6997bf731 -> 5a84b9a02
doc improvement
A minor update to give more introduction description
Author: Eugene <li...@apache.org>
Closes #460 from toyboxman/doc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin/commit/5a84b9a0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin/tree/5a84b9a0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin/diff/5a84b9a0
Branch: refs/heads/master
Commit: 5a84b9a02d5633c97e396a534b7ff8bd8be44f71
Parents: 6997bf7
Author: Eugene <li...@apache.org>
Authored: Thu Nov 29 19:03:15 2018 -0700
Committer: William Guo <gu...@apache.org>
Committed: Thu Nov 29 19:03:15 2018 -0700
----------------------------------------------------------------------
README.md | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/5a84b9a0/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 69496d9..4ce1eb1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,3 @@
-
-
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -23,7 +21,10 @@ under the License.
# Apache Griffin
[](https://travis-ci.org/apache/incubator-griffin) [](https://www.apache.org/licenses/LICENSE-2.0.html)
-Apache Griffin is a model driven data quality solution for modern data systems. It provides a standard process to define data quality measures, execute, report, as well as an unified dashboard across multiple data systems.
+The data quality (DQ) is a key criteria for many data consumers like IoT, machine learning etc., however, there is no standard agreement on how to determine “good” data.
+Apache Griffin is a model-driven data quality service platform where you can examine your data on-demand. It provides a standard process to define data quality measures, executions and reports, allowing those examinations across multiple data systems.
+When you don't trust your data, or concern that poorly controlled data can negatively impact critical decision, you can utilize Apache Griffin to ensure data quality.
+
## Getting Started
@@ -59,7 +60,16 @@ You can access our issues on [JIRA page](https://issues.apache.org/jira/browse/G
## Contributing
-See [How to Contribute](http://griffin.apache.org/2017/03/04/community) for details on how to contribute code, documentation, etc.
+See [How to Contribute](http://griffin.apache.org/docs/contribute.html) for details on how to contribute code, documentation, etc.
+
+Here's the most direct way to contribute your work merged into Apache Griffin.
+
+* Fork the project from [github](https://github.com/apache/incubator-griffin)
+* Clone down your fork
+* Implement your feature or bug fix and commit changes
+* Push the branch up to your fork
+* Send a pull request to Apache Griffin branch
+
## References
- [Home Page](http://griffin.incubator.apache.org/)