diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 99b17dad..7a54ac33 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -38,8 +38,7 @@ jobs: - name: "Sync documentation changes" run: | - mkdir -p docs-repo/$(dirname $TARGET_DOCS_FILE) - cp -v merged.md docs-repo/$TARGET_DOCS_FILE + cp -v docs/merged.md docs-repo/$TARGET_DOCS_FILE - name: "Create commit & pull request" uses: "peter-evans/create-pull-request@v7" with: diff --git a/docs/zed.md b/docs/zed.md index 3f29c67c..0eee642e 100644 --- a/docs/zed.md +++ b/docs/zed.md @@ -39,7 +39,6 @@ zed permission check --explain document:firstdoc writer user:emilia * [zed context](#zed-context) - Manage configurations for connecting to SpiceDB deployments * [zed import](#zed-import) - Imports schema and relationships from a file or url * [zed permission](#zed-permission) - Query the permissions in a permissions system -* [zed preview](#zed-preview) - Experimental commands that have been made available for preview * [zed relationship](#zed-relationship) - Query and mutate the relationships in a permissions system * [zed schema](#zed-schema) - Manage schema for a permissions system * [zed use](#zed-use) - Alias for `zed context use` @@ -775,108 +774,6 @@ zed permission lookup-subjects [flags] -``` - -### Examples - -``` - - Write to stdout: - zed preview schema compile root.zed - Write to an output file: - zed preview schema compile root.zed --out compiled.zed - -``` - -### Options - -``` - --out string output filepath; omitting writes to stdout -``` - -### Options Inherited From Parent Flags - -``` - --certificate-path string path to certificate authority used to verify secure connections - --endpoint string spicedb gRPC API endpoint - --hostname-override string override the hostname used in the connection to the endpoint - --insecure connect over a plaintext connection - --log-format string format of logs ("auto", "console", "json") (default "auto") - --log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info") - --max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed - --max-retries uint maximum number of sequential retries to attempt when a request fails (default 10) - --no-verify-ca do not attempt to verify the server's certificate chain and host name - --permissions-system string permissions system to query - --proxy string specify a SOCKS5 proxy address - --request-id string optional id to send along with SpiceDB requests for tracing - --skip-version-check if true, no version check is performed against the server - --token string token used to authenticate to SpiceDB -``` - - - ## Reference: `zed relationship` Query and mutate the relationships in a permissions system @@ -1168,12 +1065,59 @@ Manage schema for a permissions system ### Children commands +* [zed schema compile](#zed-schema-compile) - Compile a schema that uses extended syntax into one that can be written to SpiceDB * [zed schema copy](#zed-schema-copy) - Copy a schema from one context into another * [zed schema diff](#zed-schema-diff) - Diff two schema files * [zed schema read](#zed-schema-read) - Read the schema of a permissions system * [zed schema write](#zed-schema-write) - Write a schema file (.zed or stdin) to the current permissions system +## Reference: `zed schema compile` + +Compile a schema that uses extended syntax into one that can be written to SpiceDB + +``` +zed schema compile [flags] +``` + +### Examples + +``` + + Write to stdout: + zed preview schema compile root.zed + Write to an output file: + zed preview schema compile root.zed --out compiled.zed + +``` + +### Options + +``` + --out string output filepath; omitting writes to stdout +``` + +### Options Inherited From Parent Flags + +``` + --certificate-path string path to certificate authority used to verify secure connections + --endpoint string spicedb gRPC API endpoint + --hostname-override string override the hostname used in the connection to the endpoint + --insecure connect over a plaintext connection + --log-format string format of logs ("auto", "console", "json") (default "auto") + --log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info") + --max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed + --max-retries uint maximum number of sequential retries to attempt when a request fails (default 10) + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --proxy string specify a SOCKS5 proxy address + --request-id string optional id to send along with SpiceDB requests for tracing + --skip-version-check if true, no version check is performed against the server + --token string token used to authenticate to SpiceDB +``` + + + ## Reference: `zed schema copy` Copy a schema from one context into another