Skip to content

Commit

Permalink
docs(coding-standards): amended to reference docs directory and table…
Browse files Browse the repository at this point in the history
… documentation
  • Loading branch information
graza-io committed Nov 1, 2024
1 parent 7ad8400 commit 62f44a7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/develop/coding-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Along with the following directories
- `models` (required): Contains go files for models (table row schema) used by the plugin.
- `sources` (optional): May contain go files for any sources required that aren't provided by the SDK, along with any required configuration schemas.
- `tables` (required): Contains go files for table definitions `{model_name}_table.go` and table specific configuration `{model_name}_table_config.go`.
- `docs` (required): Containing documentation, especially table docs.

### Example: Repo Structure

Expand All @@ -45,6 +46,11 @@ tailpipe-plugin-example
├── go.mod
├── go.sum
├── main.go
├── docs
│ ├── index.md
│ └── tables
│ ├── access_log.md
│ └── audit_log.md
├── mappers
│   ├── access_log_mapper.go
│   └── audit_log_mapper.go
Expand Down

0 comments on commit 62f44a7

Please sign in to comment.