You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There should be a fixed set of sections and standards for the connector documentation.
The connector docs should follow the following layout:
# Title* Brief description of the connector. Link to relevant external documentation
* Small spicepod sample
## Configuration### `from`
<Explanation of the `from` field>
### `name`
Name of the dataset, used as the table name in Spice.
Example:
```yamldatasets:
- from: s3://s3-bucket-name/taxi_sample.csvname: cool_datasetparams:
file_format: csv``````sqlSELECT COUNT(*) FROM cool_dataset;``````shell
+----------+
| count(*) |
+----------+
| 6001215 |
+----------+
```### `params`
A markdown table of the available parameters. Parameters can be split up into multiple tables for readability. Parameters that support secrets should link to the "Using secrets" section at the end of the page
## Examples
Each example should have a heading and optionally a very brief description. There should be as many examples as possible
## Using secrets
A section describing and linking to the Secrets page. Avoid using the `TabItem`s because they're hard to link to. If there's an example of a specific use case of using one of the secrets providers, include it in the Examples section. This section should look like so:
## Secrets
Spice supports three types of [secret stores](/components/secret-stores):
*[Environment variables](/components/secret-stores/env)*[Kubernetes Secret Store](/components/secret-stores/kubernetes)*[Keyring Secret Store](/components/secret-stores/keyring)
Explore the different options to manage sensitive data securely.
The text was updated successfully, but these errors were encountered:
There should be a fixed set of sections and standards for the connector documentation.
The connector docs should follow the following layout:
The text was updated successfully, but these errors were encountered: