|
1 | | -import { Cards, Card, Steps } from 'nextra/components' |
2 | | -import YouTube from 'react-youtube' |
3 | | -import { faTerminal, faServer, faQuestion, faHand, faDollarSign, faPhone } from '@fortawesome/free-solid-svg-icons' |
4 | | -import { faDocker, faAws } from '@fortawesome/free-brands-svg-icons' |
| 1 | +import { Cards, Card } from 'nextra/components' |
| 2 | +import { faQuestion, faHand, faDollarSign } from '@fortawesome/free-solid-svg-icons' |
5 | 3 | import { FontAwesomeIcon } from '@fortawesome/react-fontawesome' |
6 | 4 |
|
7 | | -import { InlinePlayground } from '@/components/playground' |
8 | | - |
9 | 5 | # SpiceDB Documentation |
10 | 6 |
|
11 | 7 | Welcome to the official documentation for the SpiceDB ecosystem. |
12 | 8 |
|
13 | 9 | <Cards> |
14 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faHand} />} title="New? Follow our first steps guide" href="#first-steps" /> |
| 10 | +<Card arrow={true} icon={<FontAwesomeIcon icon={faHand} />} title="New? Follow our first steps guide" href="first-steps" /> |
15 | 11 | <Card arrow={true} icon={<FontAwesomeIcon icon={faQuestion} />} title="Got questions? Our FAQ has answers" href="faq" /> |
16 | 12 | <Card arrow={true} icon={<FontAwesomeIcon icon={faDollarSign} />} title="Paid products? That's the AuthZed docs" href="../../authzed/guides/picking-a-product" /> |
17 | 13 | </Cards> |
@@ -86,91 +82,3 @@ Features that distinguish SpiceDB from other systems include: |
86 | 82 | [OpenTelemetry]: https://opentelemetry.io |
87 | 83 |
|
88 | 84 | [Google's Zanzibar paper]: https://authzed.com/zanzibar |
89 | | - |
90 | | -## First steps |
91 | | - |
92 | | -<Steps> |
93 | | - |
94 | | -### Dive into some videos |
95 | | - |
96 | | -SpiceDB developers and community members have recorded videos explaining concepts, modeling familiar applications, and deep-diving into the tech powering everything! |
97 | | - |
98 | | -<br /> |
99 | | -<YouTube videoId="p8xh_z6PUqE" className="youtubeContainer" opts={{playerVars:{start: 228}}} /> |
100 | | -<YouTube videoId="WTfZsRPDv9Q" className="youtubeContainer" /> |
101 | | -<YouTube videoId="x3-B9-ICj0w" className="youtubeContainer" /> |
102 | | - |
103 | | -### Join the SpiceDB Discord |
104 | | - |
105 | | -Thousands of community members chat interactively in our [Discord][discord]. |
106 | | -Why not ask them a question or two? |
107 | | - |
108 | | -<br /> |
109 | | -<iframe src="https://e.widgetbot.io/channels/844600078504951838/844600078948630559" allow="clipboard-write; fullscreen" className="w-full min-h-[400px] lg:min-h-[600px]"></iframe> |
110 | | - |
111 | | -[discord]: https://authzed.com/discord |
112 | | - |
113 | | -### Install the SpiceDB toolchain |
114 | | - |
115 | | -SpiceDB and Zed run on Linux, macOS, and Windows on both AMD64 and ARM64 architectures. |
116 | | - |
117 | | -Follow the instructions below to install to your development machine: |
118 | | - |
119 | | -<Cards> |
120 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faServer} />} title="Install the SpiceDB server binary" href="/spicedb/getting-started/installing-spicedb" /> |
121 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faTerminal} />} title="Install the SpiceDB CLI tool: Zed" href="/spicedb/getting-started/installing-zed" /> |
122 | | -</Cards> |
123 | | - |
124 | | -### Learn the concepts |
125 | | - |
126 | | -We've documented the concepts SpiceDB users should understand: |
127 | | - |
128 | | -<Cards> |
129 | | -<Card arrow={true} title="Zanzibar" href="../concepts/zanzibar" /> |
130 | | -<Card arrow={true} title="Schema" href="../concepts/schema" /> |
131 | | -<Card arrow={true} title="Relationships" href="../concepts/relationships" /> |
132 | | -</Cards> |
133 | | - |
134 | | -After these, we recommend these concepts for running SpiceDB: |
135 | | - |
136 | | -<Cards> |
137 | | -<Card arrow={true} title="Commands" href="../concepts/commands" /> |
138 | | -<Card arrow={true} title="Datastores" href="../concepts/datastores" /> |
139 | | -<Card arrow={true} title="Datastore Migrations" href="../concepts/datastore-migrations" /> |
140 | | -<Card arrow={true} title="Observability" href="../ops/observability" /> |
141 | | -<Card arrow={true} title="Operator" href="../concepts/operator" /> |
142 | | -</Cards> |
143 | | - |
144 | | -Finally, some more advanced concepts are still fundamental: |
145 | | - |
146 | | -<Cards> |
147 | | -<Card arrow={true} title="Consistency" href="../concepts/consistency" /> |
148 | | -<Card arrow={true} title="Caveats" href="../concepts/caveats" /> |
149 | | -<Card arrow={true} title="Dispatch" href="../concepts/dispatch" /> |
150 | | -</Cards> |
151 | | - |
152 | | -### Experiment in the Playground |
153 | | - |
154 | | -You can experiment with and share schema and data snippets on the [Playground][pg]. |
155 | | - |
156 | | -When you're done, you can easily import these into a real SpiceDB instance using `zed import`. |
157 | | - |
158 | | -Here's an easy example to toy with: |
159 | | - |
160 | | -<br /><InlinePlayground reference="m1lRfaaYf9XP" /> |
161 | | - |
162 | | -[pg]: https://play.authzed.com |
163 | | - |
164 | | -### Take SpiceDB to Production |
165 | | - |
166 | | -Once you're ready to take things into production, you can reference our guides or explore a managed solution with AuthZed. |
167 | | - |
168 | | -Even if you aren't interested in paid products, you can still schedule a call or reach out on Discord. |
169 | | - |
170 | | -<Cards> |
171 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faDocker} />} title="Deploy the Operator on Kubernetes" href="/spicedb/ops/deploying-spicedb-operator" /> |
172 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faAws} />} title="Install a SpiceDB cluster on Amazon EKS" href="/spicedb/getting-started/install/eks" /> |
173 | | -<Card arrow={true} icon={<FontAwesomeIcon icon={faPhone} />} title="Schedule a call with AuthZed" href="https://authzed.com/call?utm_source=docs_discovering_spicedb" /> |
174 | | -</Cards> |
175 | | - |
176 | | -</Steps> |
0 commit comments