From 5bfb06b9a9c34f2f042c28efa8f14b6547d62b3f Mon Sep 17 00:00:00 2001 From: Felix GV Date: Mon, 26 Sep 2022 14:17:30 -0700 Subject: [PATCH] [doc] Added link to new blog post and minor clean ups. --- CONTRIBUTING.md | 4 --- README.md | 8 +++-- docs/dev_guide/pull_request_guideline.md | 39 ------------------------ 3 files changed, 5 insertions(+), 46 deletions(-) delete mode 100644 docs/dev_guide/pull_request_guideline.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 395d975a5e6..f0f6f7c80ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,10 +28,6 @@ If you have any feature request, please create a new GitHub issue and the commun If you have any user feedback, please create a new GitHub issue and the community will collect your feedback and work on it. -## Pull Request Guideline - -Detailed Pull Request guideline is at [Venice Pull Request Guideline](./docs/dev_guide/pull_request_guideline.md) - ## For New Contributors Please follow [Venice Workspace Setup](./docs/dev_guide/workspace_setup.md) and diff --git a/README.md b/README.md index b74ae226494..6dcb45be809 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Venice is a derived data storage platform, providing the following characteristi 4. Multi-cluster support within each region with operator-driven cluster assignment. 5. Multi-tenancy, horizontal scalability and elasticity within each cluster. -The above makes Venice particularly suitable as the stateful component backing a Feature Store, such as [Feathr](https://github.com/linkedin/feathr). AI applications feed the output of their ML training jobs into Venice and then query the data for use during online inference workloads. +The above makes Venice particularly suitable as the stateful component backing a Feature Store, such as [Feathr](https://github.com/feathr-ai/feathr). AI applications feed the output of their ML training jobs into Venice and then query the data for use during online inference workloads. Write Path ---------- @@ -61,7 +61,7 @@ There are two main client modes for accessing Venice data: Getting Started =============== -Refer [Venice quickstart](https://github.com/linkedin/venice/tree/master/quickstart) to create your own Venice cluster and play around with some features like creating a data store, batch push, incremental push, and single get. +Refer to the [Venice quickstart](./quickstart/README.md) to create your own Venice cluster and play around with some features like creating a data store, batch push, incremental push, and single get. Previously Published Content ============================ @@ -74,6 +74,7 @@ The following blog posts have previously been published about Venice: - 2018: [Venice Performance Optimization](https://engineering.linkedin.com/blog/2018/04/venice-performance-optimization) - 2021: [Taming memory fragmentation in Venice with Jemalloc](https://engineering.linkedin.com/blog/2021/taming-memory-fragmentation-in-venice-with-jemalloc) - 2022: [Supporting large fanout use cases at scale in Venice](https://engineering.linkedin.com/blog/2022/supporting-large-fanout-use-cases-at-scale-in-venice) +- 2022: [Open Sourcing Venice – LinkedIn’s Derived Data Platform](https://engineering.linkedin.com/blog/2022/open-sourcing-venice--linkedin-s-derived-data-platform) The following talks have been given about Venice: @@ -87,9 +88,10 @@ Community Resources =================== Feel free to engage with the community using our: -- [Slack workspace](https://join.slack.com/t/venicedb/shared_invite/zt-1gppaxfas-KxNjBQzq4_EUM_NGMGMQ3Q) +- [Slack workspace](https://communityinviter.com/apps/venicedb/venice) - [LinkedIn group](https://www.linkedin.com/groups/14129519/) - [Twitter handle](https://twitter.com/VeniceDataBase) - GitHub [issues](https://github.com/linkedin/venice/issues) and [discussions](https://github.com/linkedin/venice/discussions) +- The [contributor's guide](./CONTRIBUTING.md). [//]: # (TODO: Add link to setup and execution guide) \ No newline at end of file diff --git a/docs/dev_guide/pull_request_guideline.md b/docs/dev_guide/pull_request_guideline.md deleted file mode 100644 index 37665e9738d..00000000000 --- a/docs/dev_guide/pull_request_guideline.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: Venice Pull Request(PR) Guideline -parent: Developer Guides ---- - -# Venice Pull Request(PR) Guideline - -## Creating GitHub issue - -Every PR should be preceded by a GitHub issue to explain the problem statement unless it's a trivial bug fixes or a -documentation change. If your change is significant, please make sure your PR reviewers can align on the problem -statement via GitHub issues first. - -The GitHub issue should contain the detailed problem statement. - -## PR Description - -Describe - -* What changes to make and why you are making these changes. -* How are you going to achieve your goal -* Describe what testings you have done, for example, performance testing etc. - -Checklist that might be helpful to facilitate the review: - -* Design one-pager, design doc, or RFC -* GitHub Issue - -### Added new dependencies? - -Please list the new dependencies in the PR description and answer these questions for each new dependency - -* What's their license? -* Are they compatible with our license? - -## Attribution & Acknowledgements - -This guide is based on the [Feathr Pull Request Guideline](https://linkedin.github.io/feathr/dev_guide/pull_request_guideline.html). \ No newline at end of file