Skip to content

Commit

Permalink
docs(coding-standards): updated models to rows (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
graza-io authored Nov 5, 2024
1 parent 62f44a7 commit 60cf51d
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 9 deletions.
53 changes: 53 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build
/output

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local

# Editor cache and lock files
*.swp
*.swo

# vercel
.vercel

# Jetbrains
.idea/

# Auto-generated robots.txt and sitemap.xml
/public/robots.txt
/public/sitemap.xml
/public/blog/feed.xml
/public/images/docs
/public/images/reference_examples
/steampipe-docs-local

# vscode
.vscode/
18 changes: 9 additions & 9 deletions docs/develop/coding-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Each plugin should reside in a separate GitHub repository, named `tailpipe-plugi
Along with the following directories
- `{plugin name}` (required): This should contain `plugin.go`.
- `mappers` (optional): May contain go files for any specific mappers required by the plugin in format `{model_name}_mapper.go`.
- `models` (required): Contains go files for models (table row schema) used by the plugin.
- `rows` (required): Contains go files which define the table schema(s) used in 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.
Expand All @@ -42,7 +42,7 @@ tailpipe-plugin-example
├── Makefile
├── README.md
├── example
   └── plugin.go
└── plugin.go
├── go.mod
├── go.sum
├── main.go
Expand All @@ -52,14 +52,14 @@ tailpipe-plugin-example
│ ├── access_log.md
│ └── audit_log.md
├── mappers
   ├── access_log_mapper.go
   └── audit_log_mapper.go
├── models
   ├── access_log.go
   └── audit_log.go
├── access_log_mapper.go
└── audit_log_mapper.go
├── rows
├── access_log.go
└── audit_log.go
├── sources
   ├── audit_log_api_source.go
   └── audit_log_api_source_config.go
├── audit_log_api_source.go
└── audit_log_api_source_config.go
└── tables
├── access_log_table.go
├── access_log_table_config.go
Expand Down

0 comments on commit 60cf51d

Please sign in to comment.