From fa844fe86a096986a84a8bba42f64f3ad723c060 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Thu, 13 Jun 2024 16:36:35 -0700 Subject: [PATCH] *: add metadata, clean up readme a little --- .github/workflows/cla.yaml | 23 +++++++++++++ CODE-OF-CONDUCT.md | 24 ++++++++++++++ DCO | 37 +++++++++++++++++++++ NOTICE | 5 +++ README.md | 67 +++++--------------------------------- 5 files changed, 97 insertions(+), 59 deletions(-) create mode 100644 .github/workflows/cla.yaml create mode 100644 CODE-OF-CONDUCT.md create mode 100644 DCO create mode 100644 NOTICE diff --git a/.github/workflows/cla.yaml b/.github/workflows/cla.yaml new file mode 100644 index 0000000..f0dc18e --- /dev/null +++ b/.github/workflows/cla.yaml @@ -0,0 +1,23 @@ +--- +name: "CLA" +on: # yamllint disable-line rule:truthy + issue_comment: + types: + - "created" + pull_request_target: + types: + - "opened" + - "closed" + - "synchronize" + merge_group: + types: + - "checks_requested" +jobs: + cla: + name: "Check Signature" + runs-on: "buildjet-2vcpu-ubuntu-2204" + steps: + - uses: "authzed/actions/cla-check@main" + with: + github_token: "${{ secrets.GITHUB_TOKEN }}" + cla_assistant_token: "${{ secrets.CLA_ASSISTANT_ACCESS_TOKEN }}" diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..868514b --- /dev/null +++ b/CODE-OF-CONDUCT.md @@ -0,0 +1,24 @@ +# Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery +- Personal attacks +- Trolling or insulting/derogatory comments +- Public or private harassment +- Publishing other’s private information, such as physical or electronic addresses, without explicit permission +- Other unethical or unprofessional conduct + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. +By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. +Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available [here](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html) diff --git a/DCO b/DCO new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/DCO @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..d2854e1 --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +SpiceDB +Copyright 2024 Authzed, Inc + +This product includes software developed at +Authzed, Inc. (https://www.authzed.com/). diff --git a/README.md b/README.md index e50a63a..66a507d 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,18 @@ -

- - spicedb logo - - - spicedb Logo - -

+# SpiceDB for Visual Studio Code +Visual Studio Marketplace +discord badge +twitter badge +linkedin badge -

- SpiceDB sets the standard for authorization that scales. -

Scale with
- Traffic • Dev Velocity • Functionality • Geography -

+Official VS Code extension providing syntax highlighting, semantic information, and additional UI components for working with [SpiceDB] [schema] and [relationships data]. -

- discord badge -   - twitter badge -   - linkedin badge -

- -# SpiceDB Extension for VS Code - -VS Code extension that provides syntax highlighting, semantic information and addition UI for working with [SpiceDB] [schema] and [relationships data]. - -Brings [SpiceDB Playground] functionality into VS Code. +This extension brings the [SpiceDB Playground] experience natively to VS Code. [SpiceDB]: https://spicedb.io [schema]: https://authzed.com/docs/spicedb/concepts/schema [relationships data]: https://authzed.com/docs/spicedb/concepts/relationships [SpiceDB Playground]: https://play.authzed.com -

-Visual Studio Marketplace -Release -License -

- -## What is SpiceDB? - -SpiceDB is a graph database purpose-built for storing and evaluating access control data. - -As of 2021, [broken access control became the #1 threat to the web][owasp]. With SpiceDB, developers finally have the solution to stopping this threat the same way as the hyperscalers. - -[owasp]: https://owasp.org/Top10/A01_2021-Broken_Access_Control/ - -### Why SpiceDB? - -- [**World-class engineering**][about]: painstakingly built by experts that pioneered the cloud-native ecosystem -- [**Authentic design**][zanzibar]: mature and feature-complete implementation of Google's Zanzibar paper -- [**Proven in production**][1M]: 5ms p95 when scaled to millions of queries/s, billions of relationships -- [**Global consistency**][consistency]: consistency configured per-request unlocks correctness while maintaining performance -- [**Multi-paradigm**][caveats]: caveated relationships combine the best concepts in authorization: ABAC & ReBAC -- [**Safety in tooling**][tooling]: designs schemas with real-time validation or validate in your CI/CD workflow -- [**Reverse Indexes**][reverse-indexes]: queries for "What can `subject` do?", "Who can access `resource`?" - -[about]: https://authzed.com/why-authzed -[zanzibar]: https://authzed.com/zanzibar -[1M]: https://authzed.com/blog/google-scale-authorization -[caveats]: https://netflixtechblog.com/abac-on-spicedb-enabling-netflixs-complex-identity-types-c118f374fa89 -[tooling]: https://authzed.com/docs/spicedb/modeling/validation-testing-debugging -[reverse-indexes]: https://authzed.com/docs/spicedb/getting-started/faq#what-is-a-reverse-index -[consistency]: https://authzed.com/docs/spicedb/concepts/consistency - ## Installation The SpiceDB VS Code Extension can be installed from the [VS Code Extension Marketplace]. @@ -76,7 +25,7 @@ The SpiceDB VS Code Extension can be installed from the [VS Code Extension Marke -### Real time validation and diagnotics +### Real time validation and diagnostics