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.

Sign up for GitHub

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

Jump to bottom

README: rework sections: zanzibar, contrib, users #2060

Merged
merged 2 commits into from
Sep 18, 2024
Merged

README: rework sections: zanzibar, contrib, users #2060

merged 2 commits into from
Sep 18, 2024

Conversation

jzelinskie
Copy link
Member

@jzelinskie jzelinskie commented Sep 9, 2024 •
edited
Loading

This reworks the README a little bit

  • Adds a high-level architecture image to "What is" section (works in dark mode too!)
  • Reworks text on "What is" section to lean on relational databases and mention relation to authN
  • Adds a Zanzibar section
  • Adds a "Who's using" section with a few interesting community projects; we can workshop these over time, but i aimed to get some variety in domains and languages
  • Moved reading materials from contributing to Getting Started
  • Added some contributor companies in the contributing section

@jzelinskie jzelinskie requested a review from a team as a code owner September 9, 2024 15:12
@github-actions github-actions bot added the area/docs Affects docs or metadata (e.g. README) label Sep 9, 2024
tstirrat15
tstirrat15 previously approved these changes Sep 9, 2024
View reviewed changes
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jzelinskie jzelinskie force-pushed the adoptors branch 2 times, most recently from 0678fc9 to b325c4c Compare September 18, 2024 20:27
@jzelinskie jzelinskie force-pushed the adoptors branch 2 times, most recently from 60fbb87 to 8826c15 Compare September 18, 2024 21:57
tstirrat15
tstirrat15 approved these changes Sep 18, 2024
View reviewed changes
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jzelinskie jzelinskie added this pull request to the merge queue Sep 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 18, 2024
@jzelinskie jzelinskie added this pull request to the merge queue Sep 18, 2024
Merged via the queue into authzed:main with commit c5a5aff Sep 18, 2024
22 checks passed
@jzelinskie jzelinskie deleted the adoptors branch September 18, 2024 22:37
@github-actions github-actions bot locked and limited conversation to collaborators Sep 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@tstirrat15 tstirrat15 tstirrat15 approved these changes

Assignees
No one assigned
Labels
area/docs Affects docs or metadata (e.g. README)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jzelinskie @tstirrat15