This is an automated email from the ASF dual-hosted git repository.
madhan pushed a commit to branch atlas-2.5
in repository https://gitbox.apache.org/repos/asf/atlas.git
The following commit(s) were added to refs/heads/atlas-2.5 by this push:
new 87a9eb539 Update and rename README.txt to README.md (#271)
87a9eb539 is described below
commit 87a9eb539c9ec7013b4bc0563e1a8a3d25cf63c5
Author: Abhishek Kumar <[email protected]>
AuthorDate: Mon Jan 27 08:43:10 2025 -0800
Update and rename README.txt to README.md (#271)
(cherry picked from commit 4899bf33c5c3431f4f8ada18b17782f584194218)
---
README.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.txt | 71 ------------------------------------------------
2 files changed, 92 insertions(+), 71 deletions(-)
diff --git a/README.md b/README.md
new file mode 100755
index 000000000..cddc9a64c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+Apache Atlas Overview
+=====================
+[](https://www.apache.org/licenses/LICENSE-2.0.txt)
+[](https://pypi.org/project/apache-atlas/)
+[](https://atlas.apache.org)
+[](https://cwiki.apache.org/confluence/display/ATLAS/)
+
+Apache Atlas framework is an extensible set of core
+foundational governance services – enabling enterprises to effectively and
+efficiently meet their compliance requirements within Hadoop and allows
+integration with the whole enterprise data ecosystem.
+
+This will provide true visibility in Hadoop by using both a prescriptive
+and forensic model, along with technical and operational audit as well as
+lineage enriched by business taxonomical metadata. It also enables any
+metadata consumer to work inter-operably without discrete interfaces to
+each other -- the metadata store is common.
+
+The metadata veracity is maintained by leveraging Apache Ranger to prevent
+non-authorized access paths to data at runtime.
+Security is both role based (RBAC) and attribute based (ABAC).
+
+
+
+#### NOTE
+Apache Atlas allows contributions via pull requests (PRs) on GitHub.
Alternatively, use [this](https://reviews.apache.org) to submit changes for
review using the Review Board.
+Also create a [atlas jira](https://issues.apache.org/jira/browse/ATLAS) to go
along with the review and mention it in the pull request/review board review.
+
+
+Building Atlas in Docker
+=============
+
+Instructions to build and run atlas in docker:
`dev-support/atlas-docker/README.md`
+
+Regular Build Process
+=============
+
+1. Get Atlas sources to your local directory, for example with following
commands
+ ```
+ cd <your-local-directory>
+ git clone https://github.com/apache/atlas.git
+ cd atlas
+
+ # Checkout the branch or tag you would like to build
+
+ # to checkout a branch
+ git checkout <branch>
+
+ # to checkout a tag
+ git checkout tags/<tag>
+ ```
+
+2. Execute the following commands to build Apache Atlas
+ ```
+ export MAVEN_OPTS="-Xms2g -Xmx2g"
+ mvn clean install
+ mvn clean package -Pdist
+ ```
+
+4. After above build commands successfully complete, you should see the
following files
+ ```
+ distro/target/apache-atlas-<version>-bin.tar.gz
+ distro/target/apache-atlas-<version>-hbase-hook.tar.gz
+ distro/target/apache-atlas-<version>-hive-hook.tar.gz
+ distro/target/apache-atlas-<version>-impala-hook.tar.gz
+ distro/target/apache-atlas-<version>-kafka-hook.tar.gz
+ distro/target/apache-atlas-<version>-server.tar.gz
+ distro/target/apache-atlas-<version>-sources.tar.gz
+ distro/target/apache-atlas-<version>-sqoop-hook.tar.gz
+ distro/target/apache-atlas-<version>-storm-hook.tar.gz
+ distro/target/apache-atlas-<version>-falcon-hook.tar.gz
+ distro/target/apache-atlas-<version>-couchbase-hook.tar.gz
+ ```
+
+5. For more details on installing and running Apache Atlas, please refer to
https://atlas.apache.org/#/Installation
diff --git a/README.txt b/README.txt
deleted file mode 100755
index a6062b0d8..000000000
--- a/README.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-Apache Atlas Overview
-=====================
-
-Apache Atlas framework is an extensible set of core
-foundational governance services – enabling enterprises to effectively and
-efficiently meet their compliance requirements within Hadoop and allows
-integration with the whole enterprise data ecosystem.
-
-This will provide true visibility in Hadoop by using both a prescriptive
-and forensic model, along with technical and operational audit as well as
-lineage enriched by business taxonomical metadata. It also enables any
-metadata consumer to work inter-operably without discrete interfaces to
-each other -- the metadata store is common.
-
-The metadata veracity is maintained by leveraging Apache Ranger to prevent
-non-authorized access paths to data at runtime.
-Security is both role based (RBAC) and attribute based (ABAC).
-
-
-Build Process
-=============
-
-1. Get Atlas sources to your local directory, for example with following
commands
- $ cd <your-local-directory>
- $ git clone https://github.com/apache/atlas.git
- $ cd atlas
-
- # Checkout the branch or tag you would like to build
- #
- # to checkout a branch
- $ git checkout <branch>
-
- # to checkout a tag
- $ git checkout tags/<tag>
-
-2. Execute the following commands to build Apache Atlas
-
- $ export MAVEN_OPTS="-Xms2g -Xmx2g"
- $ mvn clean install
- $ mvn clean package -Pdist
-
-3. After above build commands successfully complete, you should see the
following files
-
- distro/target/apache-atlas-<version>-bin.tar.gz
- distro/target/apache-atlas-<version>-hbase-hook.tar.gz
- distro/target/apache-atlas-<version>-hive-hook.tar.gz
- distro/target/apache-atlas-<version>-impala-hook.tar.gz
- distro/target/apache-atlas-<version>-kafka-hook.tar.gz
- distro/target/apache-atlas-<version>-server.tar.gz
- distro/target/apache-atlas-<version>-sources.tar.gz
- distro/target/apache-atlas-<version>-sqoop-hook.tar.gz
- distro/target/apache-atlas-<version>-storm-hook.tar.gz
- distro/target/apache-atlas-<version>-falcon-hook.tar.gz
-
-4. For more details on installing and running Apache Atlas, please refer to
https://atlas.apache.org/#/Installation
