From ff65f95e4a21e9efa37b2702cc1ece74a7347ad4 Mon Sep 17 00:00:00 2001 From: Shirshanka Das Date: Sat, 2 Jan 2021 16:40:23 -0800 Subject: [PATCH] docs: add links to GMA repo and RFC process from relevant places (#2045) Updating README to describe source repositories and dev model Updating CONTRIBUTING to guide contributors to RFC process --- README.md | 5 ++++- docs/CONTRIBUTING.md | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a76a83e5ad..5da80928b6 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,14 @@ DataHub is LinkedIn's generalized metadata search & discovery tool. Read about the architectures of different metadata systems and why DataHub excels [here](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained). Also read our [LinkedIn Engineering blog post](https://engineering.linkedin.com/blog/2019/data-hub), check out our [Strata presentation](https://speakerdeck.com/shirshanka/the-evolution-of-metadata-linkedins-journey-strata-nyc-2019) and watch our [Crunch Conference Talk](https://www.youtube.com/watch?v=OB-O0Y6OYDE). You should also visit [DataHub Architecture](docs/architecture/architecture.md) to get a better understanding of how DataHub is implemented and [DataHub Onboarding Guide](docs/how/entity-onboarding.md) to understand how to extend DataHub for your own use cases. -This repository contains the complete source code for both DataHub's frontend & backend. You can also read about [how we sync the changes](https://engineering.linkedin.com/blog/2020/open-sourcing-datahub--linkedins-metadata-search-and-discovery-p) between our internal fork and GitHub. ## Quickstart Please follow the [DataHub Quickstart Guide](docs/quickstart.md) to get a copy of DataHub up & running locally using [Docker](https://docker.com). As the guide assumes some basic knowledge of Docker, we'd recommend you to go through the "Hello World" example of [A Docker Tutorial for Beginners](https://docker-curriculum.com) if Docker is completely foreign to you. +## Source Code and Repositories +* [linkedin/datahub](https://github.com/linkedin/datahub): This repository contains the complete source code for both DataHub's frontend & backend services. We currently follow a hybrid open source model for development in this repository. See [this blog post](https://engineering.linkedin.com/blog/2020/open-sourcing-datahub--linkedins-metadata-search-and-discovery-p) for details on how we do it. +* [linkedin/datahub-gma](https://github.com/linkedin/datahub-gma): This repository contains the source code for DataHub's metadata infrastructure libraries (Generalized Metadata Architecture, or GMA). We follow an open-source-first model for development in this repository. + ## Documentation * [DataHub Developer's Guide](docs/developers.md) * [DataHub Architecture](docs/architecture/architecture.md) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2e4f02c594..4e12aee650 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -14,6 +14,10 @@ If you find a bug: 1. If the issue still reproduces or has not yet been reported, try to isolate the problem before opening an issue. +## Submitting a Request For Comment (RFC) + +If you have a substantial feature or a design discussion that you'd like to have with the community follow the RFC process outlined [here](https://github.com/linkedin/datahub/blob/master/docs/rfc.md) + ## Submitting a Pull Request (PR) Before you submit your Pull Request (PR), consider the following guidelines: