Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue links to readme #694

Merged
merged 1 commit into from
Jul 26, 2022
Merged

Add issue links to readme #694

merged 1 commit into from
Jul 26, 2022

Conversation

samkim
Copy link
Member

@samkim samkim commented Jul 12, 2022

Link to priority labeled issues

@samkim samkim requested a review from a team July 12, 2022 19:17
@github-actions github-actions bot added the area/docs Affects docs or metadata (e.g. README) label Jul 12, 2022
vroldanbet
vroldanbet previously approved these changes Jul 14, 2022
@jzelinskie
Copy link
Member

Does this maybe make more sense in CONTRIBUTING.md?

@samkim
Copy link
Member Author

samkim commented Jul 18, 2022

Does this maybe make more sense in CONTRIBUTING.md?

Add to both? Included it in the readme for max visibility

@jzelinskie
Copy link
Member

jzelinskie commented Jul 19, 2022

how about not having the section at the bottom, but instead having it below the CONTRIBUTING link

look near the bottom of this block. I also moved around the links to make it less crowded

# SpiceDB

[![Container Image](https://img.shields.io/github/v/release/authzed/spicedb?color=%232496ED&label=container&logo=docker "Container Image")](https://hub.docker.com/r/authzed/spicedb/tags)
[![Docs](https://img.shields.io/badge/docs-authzed.com-%234B4B6C "Authzed Documentation")](https://docs.authzed.com)
[![Build Status](https://github.com/authzed/spicedb/workflows/Build%20&%20Test/badge.svg "GitHub Actions")](https://github.com/authzed/spicedb/actions)
[![Discord Server](https://img.shields.io/discord/844600078504951838?color=7289da&logo=discord "Discord Server")](https://discord.gg/jTysUaxXzM)
[![Twitter](https://img.shields.io/twitter/follow/authzed?color=%23179CF0&logo=twitter&style=flat-square "@authzed on Twitter")](https://twitter.com/authzed)

SpiceDB is an open source database system for managing security-critical application permissions inspired by Google's [Zanzibar] paper.

Developers create a schema that models their permissions requirements and use a [client library] to apply the schema to the database, insert data into the database, and query the data to efficiently check permissions in their applications.

[client library]: https://docs.authzed.com/reference/clients

Features that distinguish SpiceDB from other systems include:

- Expressive [gRPC] and [HTTP] APIs for checking permissions, listing access, and powering devtools
- A distributed, parallel graph-engine faithful to the architecture described in [Google's Zanzibar paper]
- A flexible consistency model configurable [per-request] that includes resistance to the [New Enemy Problem]
- An expressive [schema language] with tools for [rapid prototyping], [integration testing], and [validating designs] in CI/CD pipelines
- Pluggable storage system supporting [memdb], [MySQL], [PostgreSQL], [CockroachDB], and [Cloud Spanner]
- Deep observability with [Prometheus metrics], structured logging, and [OpenTelemetry tracing]

[gRPC]: https://buf.build/authzed/api/docs/main:authzed.api.v1
[Zanzibar]: https://authzed.com/blog/what-is-zanzibar/
[HTTP]: https://app.swaggerhub.com/apis-docs/authzed/authzed/1.0
[Google's Zanzibar paper]: https://authzed.com/blog/what-is-zanzibar/
[per-request]: https://docs.authzed.com/reference/api-consistency
[New Enemy Problem]: https://authzed.com/blog/new-enemies/
[schema language]: https://docs.authzed.com/guides/schema
[rapid prototyping]: https://play.authzed.com
[integration testing]: https://github.com/authzed/action-spicedb
[validating designs]: https://github.com/authzed/action-spicedb-validate
[memdb]: https://github.com/hashicorp/go-memdb
[MySQL]: https://www.mysql.com
[PostgreSQL]: https://www.postgresql.org
[CockroachDB]: https://github.com/cockroachdb/cockroach
[Cloud Spanner]: https://cloud.google.com/spanner
[Prometheus metrics]: https://prometheus.io
[OpenTelemetry tracing]: https://opentelemetry.io

Have questions? Join our [Discord].

Looking to contribute? See [CONTRIBUTING.md].

You can find issues by priority: [Urgent], [High], [Medium], [Low], [Maybe].
There are also [good first issues].

[Discord]: https://authzed.com/discord
[CONTRIBUTING.md]: https://github.com/authzed/spicedb/blob/main/CONTRIBUTING.md
[Urgent]: https://github.com/authzed/spicedb/labels/priority%2F0%20urgent
[High]: https://github.com/authzed/spicedb/labels/priority%2F1%20high
[Medium]: https://github.com/authzed/spicedb/labels/priority%2F2%20medium
[Low]: https://github.com/authzed/spicedb/labels/priority%2F3%20low
[Maybe]: https://github.com/authzed/spicedb/labels/priority%2F4%20maybe
[good first issues]: https://github.com/authzed/spicedb/labels/hint%2Fgood%20first%20issue

@samkim samkim merged commit 6b40647 into authzed:main Jul 26, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Jul 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Affects docs or metadata (e.g. README)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants