Linting guidance

[tamsinforbes]

Linting guidance is a more general thing - perhaps it warrants it's own page in the AP guidance that the create-a-derived-table guidance can internally link?

Approach 1: new linting page

• create a separate general linting guidance page for yamllint and sqlfluff that create-a-derived-table guidance references
• update/improve linting guidance specific to create-a-derived-table such as what lint rules are enforced
• include linting commands used in create-a-derived-table in QuickRef page
• include how to auto fix SQLfluff lint errors and use templating=ignore option to ignore Jijna templating
• include how to use YAML online formatter [note you still need to add the final empty line to pass the yamllint rule]

Approach 2: just update create-a-derived-table linting guidance

• improve general linting guidance with create-a-derived-table instructions
• update/improve linting guidance specific to create-a-derived-table such as what lint rules are enforced
• include linting commands used in create-a-derived-table in QuickRef page
• include how to auto fix SQLfluff lint errors and use templating=ignore option to ignore Jijna templating
• include how to use YAML online formatter [note you still need to add the final empty line to pass the yamllint rule]
  Notes to include/expand on
• SQLFluff has a fix command which auto-formats what it can (must NOT be run without a config). For YAML there is a helpful online website that will format code correctly (though it requires copy pasting). Add this to the user guidance.
• Useful to know what the rules are that the YAML/SQL linters will apply up front so as to try to write the code correctly from the start.