Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.07 KB

file-naming.md

File metadata and controls

20 lines (13 loc) · 1.07 KB

File naming

Content files

Content files are added to /docs subfolders.

Area of interest Parent Subfolders Filenames Example
High level overviews /docs/cloud/cloud-faq/cloud-faq-home none /docs/cloud/cloud-faq/cloud-faq-<subject> /docs/cloud/cloud-faq/cloud-faq-data-modeling
Cloud product /docs/cloud /cloud-<feature> cloud-<feature>-<task>.md /cloud/cloud-database/cloud-database-manage.md
Community product /docs/community/ /com-<feature> com-<feature>-<task>.md /community/com-tables/com-tables-create.md
SQL-guide (was SQL-preview) /docs/sql-guide /docs/sql-guide/statements/statement-table-create.md
/docs/sql-guide/functions/functions-home.md

NOTE: API docs are found in https://api-docs-featurebase-cloud.redoc.ly/

Include filenames

Include files contain common, reusable content and behave a little like Github gist files.

See README-common-include.md