From 854e4ba5d2c33405ca9c9752059f62d016fe5df1 Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Mon, 17 May 2021 11:44:22 -0700 Subject: [PATCH] docs: include license in the readme (#2559) --- README.md | 127 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 71 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 7dfca7a833..0f8b968aeb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - --- > 📣 Next DataHub town hall meeting on May 27th, 9am-10am PDT ([convert to your local time](https://greenwichmeantime.com/time/to/pacific-local/)) +> > - Topic Proposals: [submit here](https://docs.google.com/forms/d/1v2ynbAXjJlqY97xE_X1DAntNrXDznOFiNfryUkMPtkI/) > - Signup to get a calendar invite: [here](https://docs.google.com/forms/d/1r9bObXKS3tgKpISqqO3rw4yQog5zwuaFxg8IrJGUbvQ/) > - Town-hall Zoom link: [zoom.datahubproject.io](https://zoom.datahubproject.io) > - [Meeting details](docs/townhalls.md) & [past recordings](docs/townhall-history.md) -> ✨ Latest Update: +> ✨ Latest Update: +> > - Monthly project update: [Apr 2021 Edition](https://medium.com/datahub-project/linkedin-datahub-project-updates-2b0d26066b8f?source=friends_link&sk=686c47219ed294e0838ae3e2fe29084d). > - Unleashing Excellent DataOps with LinkedIn DataHub: [DataOps Unleashed Talk](https://www.youtube.com/watch?v=ccsIKK9nVxk). -> - Latest blog post [DataHub: Popular Metadata Architectures Explained](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained) @ LinkedIn Engineering Blog. +> - Latest blog post [DataHub: Popular Metadata Architectures Explained](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained) @ LinkedIn Engineering Blog. > - We've released v0.7.1. You can find release notes [here](https://github.com/linkedin/datahub/releases/tag/v0.7.1) > - We're on [Slack](docs/slack.md) now! Ask questions and keep up with the latest announcements. - ## Introduction -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 + +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. - ## Quickstart + Please follow the [DataHub Quickstart Guide](https://datahubproject.io/docs/quickstart) 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. ## Demo and Screenshots @@ -82,80 +83,94 @@ There's a [hosted demo environment](https://datahubproject.io/docs/demo) where y [![DataHub Demo GIF](docs/imgs/demo_large.gif)](https://datahubproject.io/docs/demo) ## 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. + +- [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 + We have documentation available at [https://datahubproject.io/docs/](https://datahubproject.io/docs/). ## Releases + See [Releases](https://github.com/linkedin/datahub/releases) page for more details. We follow the [SemVer Specification](https://semver.org) when versioning the releases and adopt the [Keep a Changelog convention](https://keepachangelog.com/) for the changelog format. ## FAQs + Frequently Asked Questions about DataHub can be found [here](docs/faq.md). ## Features & Roadmap + Check out DataHub's [Features](docs/features.md) & [Roadmap](docs/roadmap.md). ## Contributing + We welcome contributions from the community. Please refer to our [Contributing Guidelines](docs/CONTRIBUTING.md) for more details. We also have a [contrib](contrib) directory for incubating experimental features. ## Community + Join our [slack workspace](https://slack.datahubproject.io) for discussions and important announcements. You can also find out more about our upcoming [town hall meetings](docs/townhalls.md) and view past recordings. ## Adoption -Here are the companies that have officially adopted DataHub. Please feel free to add yours to the list if we missed it. -* [Expedia Group](http://expedia.com) -* [Experius](https://www.experius.nl) -* [Geotab](https://www.geotab.com) -* [Grofers](https://grofers.com) -* [Klarna](https://www.klarna.com) -* [LinkedIn](http://linkedin.com) -* [Saxo Bank](https://www.home.saxo) -* [Shanghai HuaRui Bank](https://www.shrbank.com) -* [ThoughtWorks](https://www.thoughtworks.com) -* [TypeForm](http://typeform.com) -* [Viasat](https://viasat.com) -* [Wolt](https://wolt.com) +Here are the companies that have officially adopted DataHub. Please feel free to add yours to the list if we missed it. + +- [Expedia Group](http://expedia.com) +- [Experius](https://www.experius.nl) +- [Geotab](https://www.geotab.com) +- [Grofers](https://grofers.com) +- [Klarna](https://www.klarna.com) +- [LinkedIn](http://linkedin.com) +- [Saxo Bank](https://www.home.saxo) +- [Shanghai HuaRui Bank](https://www.shrbank.com) +- [ThoughtWorks](https://www.thoughtworks.com) +- [TypeForm](http://typeform.com) +- [Viasat](https://viasat.com) +- [Wolt](https://wolt.com) Here is a list of companies that are currently building POC or seriously evaluating DataHub. -* [Amadeus](https://www.amadeus.com) -* [Bizzy Group](https://www.bizzy.co.id) -* [Booking.com](https://www.booking.com) -* [City of New York, DoITT](https://www1.nyc.gov/site/doitt/index.page) -* [Experian](https://www.experian.com) -* [FlixBus](https://www.flixbus.com) -* [Kindred Group](https://www.kindredgroup.com) -* [Instructure](https://www.instructure.com) -* [Inventec](https://www.inventec.com) -* [Microsoft](https://microsoft.com) -* [Morgan Stanley](https://www.morganstanley.com) -* [Orange Telecom](https://www.orange.com) -* [REEF Technology](https://reeftechnology.com) -* [SpotHero](https://spothero.com) -* [Sysco AS](https://sysco.no) -* [University of Phoenix](https://www.phoenix.edu) -* [Vectice](https://www.vectice.com) -* [Weee!](https://www.sayweee.com) + +- [Amadeus](https://www.amadeus.com) +- [Bizzy Group](https://www.bizzy.co.id) +- [Booking.com](https://www.booking.com) +- [City of New York, DoITT](https://www1.nyc.gov/site/doitt/index.page) +- [Experian](https://www.experian.com) +- [FlixBus](https://www.flixbus.com) +- [Kindred Group](https://www.kindredgroup.com) +- [Instructure](https://www.instructure.com) +- [Inventec](https://www.inventec.com) +- [Microsoft](https://microsoft.com) +- [Morgan Stanley](https://www.morganstanley.com) +- [Orange Telecom](https://www.orange.com) +- [REEF Technology](https://reeftechnology.com) +- [SpotHero](https://spothero.com) +- [Sysco AS](https://sysco.no) +- [University of Phoenix](https://www.phoenix.edu) +- [Vectice](https://www.vectice.com) +- [Weee!](https://www.sayweee.com) ## Select Articles & Talks -* [DataHub: A Generalized Metadata Search & Discovery Tool](https://engineering.linkedin.com/blog/2019/data-hub) -* [DataHub: Popular Metadata Architectures Explained](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained) -* [Open sourcing DataHub: LinkedIn’s metadata search and discovery platform](https://engineering.linkedin.com/blog/2020/open-sourcing-datahub--linkedins-metadata-search-and-discovery-p) -* [Driving DataOps Culture with LinkedIn DataHub](https://www.youtube.com/watch?v=ccsIKK9nVxk) @ [DataOps Unleashed 2021](https://dataopsunleashed.com/#shirshanka-session) -* [DataHub: Powering LinkedIn's Metadata](docs/demo/DataHub_-_Powering_LinkedIn_Metadata.pdf) @ [Budapest Data Forum 2020](https://budapestdata.hu/2020/en/) -* [Taming the Data Beast Using DataHub](https://www.youtube.com/watch?v=bo4OhiPro7Y) @ [Data Engineering Melbourne Meetup November 2020](https://www.meetup.com/Data-Engineering-Melbourne/events/kgnvlrybcpbjc/) -* [Metadata Management And Integration At LinkedIn With DataHub](https://www.dataengineeringpodcast.com/datahub-metadata-management-episode-147/) @ [Data Engineering Podcast](https://www.dataengineeringpodcast.com) -* [The evolution of metadata: LinkedIn’s story](https://speakerdeck.com/shirshanka/the-evolution-of-metadata-linkedins-journey-strata-nyc-2019) @ [Strata Data Conference 2019](https://conferences.oreilly.com/strata/strata-ny-2019.html) -* [Journey of metadata at LinkedIn](https://www.youtube.com/watch?v=OB-O0Y6OYDE) @ [Crunch Data Conference 2019](https://crunchconf.com/2019) -* [DataHub Journey with Expedia Group](https://www.youtube.com/watch?v=ajcRdB22s5o) -* [Saxo Bank's Data Workbench](https://www.slideshare.net/SheetalPratik/linkedinsaxobankdataworkbench) -* [Data Discoverability at SpotHero](https://www.slideshare.net/MaggieHays/data-discoverability-at-spothero) -* [Data Catalogue — Knowing your data](https://medium.com/albert-franzi/data-catalogue-knowing-your-data-15f7d0724900) -* [LinkedIn DataHub Application Architecture Quick Understanding](https://medium.com/@liangjunjiang/linkedin-datahub-application-architecture-quick-understanding-a5b7868ee205) -* [A Dive Into Metadata Hubs](https://www.holistics.io/blog/a-dive-into-metadata-hubs/) -* [25 Hot New Data Tools and What They DON’T Do](https://blog.amplifypartners.com/25-hot-new-data-tools-and-what-they-dont-do/) -* [Emerging Architectures for Modern Data Infrastructure](https://a16z.com/2020/10/15/the-emerging-architectures-for-modern-data-infrastructure/) + +- [DataHub: A Generalized Metadata Search & Discovery Tool](https://engineering.linkedin.com/blog/2019/data-hub) +- [DataHub: Popular Metadata Architectures Explained](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained) +- [Open sourcing DataHub: LinkedIn’s metadata search and discovery platform](https://engineering.linkedin.com/blog/2020/open-sourcing-datahub--linkedins-metadata-search-and-discovery-p) +- [Driving DataOps Culture with LinkedIn DataHub](https://www.youtube.com/watch?v=ccsIKK9nVxk) @ [DataOps Unleashed 2021](https://dataopsunleashed.com/#shirshanka-session) +- [DataHub: Powering LinkedIn's Metadata](docs/demo/DataHub_-_Powering_LinkedIn_Metadata.pdf) @ [Budapest Data Forum 2020](https://budapestdata.hu/2020/en/) +- [Taming the Data Beast Using DataHub](https://www.youtube.com/watch?v=bo4OhiPro7Y) @ [Data Engineering Melbourne Meetup November 2020](https://www.meetup.com/Data-Engineering-Melbourne/events/kgnvlrybcpbjc/) +- [Metadata Management And Integration At LinkedIn With DataHub](https://www.dataengineeringpodcast.com/datahub-metadata-management-episode-147/) @ [Data Engineering Podcast](https://www.dataengineeringpodcast.com) +- [The evolution of metadata: LinkedIn’s story](https://speakerdeck.com/shirshanka/the-evolution-of-metadata-linkedins-journey-strata-nyc-2019) @ [Strata Data Conference 2019](https://conferences.oreilly.com/strata/strata-ny-2019.html) +- [Journey of metadata at LinkedIn](https://www.youtube.com/watch?v=OB-O0Y6OYDE) @ [Crunch Data Conference 2019](https://crunchconf.com/2019) +- [DataHub Journey with Expedia Group](https://www.youtube.com/watch?v=ajcRdB22s5o) +- [Saxo Bank's Data Workbench](https://www.slideshare.net/SheetalPratik/linkedinsaxobankdataworkbench) +- [Data Discoverability at SpotHero](https://www.slideshare.net/MaggieHays/data-discoverability-at-spothero) +- [Data Catalogue — Knowing your data](https://medium.com/albert-franzi/data-catalogue-knowing-your-data-15f7d0724900) +- [LinkedIn DataHub Application Architecture Quick Understanding](https://medium.com/@liangjunjiang/linkedin-datahub-application-architecture-quick-understanding-a5b7868ee205) +- [A Dive Into Metadata Hubs](https://www.holistics.io/blog/a-dive-into-metadata-hubs/) +- [25 Hot New Data Tools and What They DON’T Do](https://blog.amplifypartners.com/25-hot-new-data-tools-and-what-they-dont-do/) +- [Emerging Architectures for Modern Data Infrastructure](https://a16z.com/2020/10/15/the-emerging-architectures-for-modern-data-infrastructure/) See the full list [here](docs/links.md). + +## License + +[Apache License 2.0](./LICENSE).