From b8d5d42f62db8d1cae17c281bfcf444056d7e371 Mon Sep 17 00:00:00 2001 From: Aditya Kajla Date: Mon, 3 Jun 2024 14:08:44 -0700 Subject: [PATCH] Update README and CONTRIBUTING --- CONTRIBUTING.md | 6 +----- README.md | 5 ----- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b9aa040..96e48568 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Prior to submitting any PRs, please review and familiarize yourself with the fol - If you find a bug or have a feature request, please [open an issue](https://github.com/warrant-dev/warrant/issues/new/choose). In order to prevent duplicate reports, please first search through existing open issues for your request prior to creating a new one. - If you discover a security issue or vulnerability, do not create an issue. Please email us with details at security@warrant.dev. - If you find small mistakes or issues in docs/instructions etc., feel free to submit PR fixes without first creating issues. -- If you'd like to contribute a fix or implementation for an issue, please first consult with a member of the Warrant team on your approach, either directly on the issue via comments or on [Slack](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w). +- If you'd like to contribute a fix or implementation for an issue, please first consult on your approach with a member of the Warrant team directly on the GitHub issue. - [Here](https://github.com/warrant-dev/warrant/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a list of 'good first issues' for new contributors. ## Making changes @@ -26,7 +26,3 @@ Prior to submitting any PRs, please review and familiarize yourself with the fol - Pull requests will trigger ci jobs that run linters, static analysis and tests. It is the submitter's responsibility to ensure that all ci checks are passing. - A member of the Warrant team will review your PR. Once approved, you may merge your PR into main. - New versions will be tagged and released automatically. - -## Getting help - -If at any point you need help, please reach out to the Warrant team via [Slack](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w). diff --git a/README.md b/README.md index 12999549..3bd2d3fc 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ GitHub GitHub release (latest by date) GitHub Workflow Status (with branch) - Slack Community Twitter Follow Backed by Y Combinator

@@ -67,10 +66,6 @@ Warrant's native SDKs are compatible with both the cloud and open-source version Visit our [docs](https://docs.warrant.dev/) to learn more about Warrant's key concepts & architecture and view our [quickstarts](https://docs.warrant.dev/quickstart/role-based-access-control/) & [API reference](https://docs.warrant.dev/objecttypes/get-all-object-types/). -### Support - -Join our [Slack community](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w) to ask questions and get support. - ## Limitations Serving check and query requests with low latency at high throughput requires running Warrant as a distributed service with the use of [Warrant-Tokens](https://docs.warrant.dev/data-consistency/) (also referred to as [Zookies](https://blog.warrant.dev/why-zanzibar-shines-at-building-authorization/#global-scale-low-latency) in Google Zanzibar). As a result, this open source version of Warrant is only capable of handling low-to-moderate throughput and is best suited for POCs, development/test environments, and low throughput use-cases.