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

feat: add project info page #221

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/markdown.links.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
},
{
"pattern": "https://github.com/openfga/dotnet-sdk"
},
{
"pattern": "https://github.com/openfga/python-sdk"
}
],
"httpHeaders": [
Expand Down
21 changes: 21 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,22 @@ using OpenFga.Sdk.Configuration;`,
],
}),
],
[
'content-docs',
/** @type {import('@docusaurus/plugin-content-docs').Options} */
({
id: 'project',
path: 'project',
routeBasePath: 'project',
editUrl: ({ docPath }) => {
return `https://github.com/openfga/openfga.dev/edit/main/project/${docPath}`;
},
editCurrentVersion: true,
showLastUpdateAuthor: true,
showLastUpdateTime: true,
sidebarPath: false,
}),
],
[
'docusaurus-plugin-module-alias',
{
Expand Down Expand Up @@ -235,6 +251,11 @@ using OpenFga.Sdk.Configuration;`,
label: 'Docs',
},
{ to: '/api/service', label: 'API', position: 'left' },
{
to: '/project/intro',
position: 'left',
label: 'Project',
},
{
to: 'https://twitter.com/OpenFGA',
label: 'Twitter',
Expand Down
61 changes: 61 additions & 0 deletions project/0-intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Project Information

## Background Information

### Goal

We were inspired by the [Google 2019 Zanzibar's paper](https://research.google/pubs/pub48190/) and believed that [fine grained authorization](https://openfga.dev/docs/authorization-and-openfga#what-is-fine-grained-authorization-fga) at scale allows application developers to model their access control layer, and to add and integrate fine-grained authorization in a way that is consistent across all of their applications.

### History

OpenFGA was originally created by Okta's [Auth0 FGA](https://docs.fga.dev/) team in 2021. It was open-sourced in June 2022 and accepted by the CNCF team for [CNCF Sandbox](https://www.cncf.io/sandbox-projects/) in September 2022.

## Contribute To OpenFGA Project

### Contribution Guideline
We welcome community contribution to this project. Please check out our [contribution guideline](https://github.com/openfga/.github/blob/main/CONTRIBUTING.md) for information on how to contribute to this project.

### Discussion

Discord and GitHub discussion board are available to discuss and ask questions with the community.
- [Discord](https://discord.gg/8naAwJfWN6)
- [GitHub discussion board](https://github.com/orgs/openfga/discussions)

### Feedback

We value your feedback. For getting the most out of your discussions post:

1. Include code examples! Even better if you can add a [Playground](https://play.fga.dev/) link.
2. Let us know what steps you've already tried.
3. Link to any relevant GitHub issues or other discussions posts.

### Report Vulnerability

Please use this [email](mailto:[email protected]) to reach out to us regarding any security concerns/vulnerabilities. Please avoid using Github issues/discussions for the same.

All vulnerabilities and associated information will be treated with full confidentiality. We strive to reply within 5 business days.

## Links

### GitHub Repos
- [Project](https://github.com/openfga)
- [Community](https://github.com/community)
- [Road Map](https://github.com/openfga/roadmap)
- [Server](https://github.com/openfga/openfga)
- [API](https://github.com/openfga/api)
- [Documentation](https://github.com/openfga/openfga.dev)
- [RFCs](https://github.com/openfga/api)
- [Sample Stores](https://github.com/openfga/sample-stores)
- [SDK Generator](https://github.com/openfga/sdk-generator)
- [Syntax Transformer](https://github.com/openfga/syntax-transformer)

### Generated SDKs
- [.NET](https://github.com/openfga/dotnet-sdk)
- [Go](https://github.com/openfga/go-sdk)
- [JS](https://github.com/openfga/js-sdk)
- [Python](https://github.com/openfga/python-sdk)

### How To Reach Us
- [Discord](https://discord.gg/8naAwJfWN6)
- [E-mail](mailto:[email protected])
- [Twitter](https://twitter.com/OpenFGA)