learncf / cfsnippets-site Goto Github PK

Allow users to browse a "Cheatsheet" page.

• Group snippets by a new cheatsheet field.
• Add new ES document type of "cheatsheet" with title, subtitle, and description fields.
• Build a nice beautiful landing page for these cheatsheets.

Example:

Datasources Cheatsheet

Copy-paste datasource config structs for easy copy-paste database setup in Lucee server

• [H2 dsn]
• [Postgres dsn]
• [MSSQL dsn]

It's really important for devs to know if a particular snippet will work in their environment. There are differences between, say, CF2016 and Lucee 5.3.

I propose some sort of tags which devs can search for which clearly show which versions the snippet is restricted to.

Need to show:

• If a code snippets works on all major engines - [all engines]
• If a snippet only works in Lucee or Adobe engines - [Lucee-only], [Adobe-only]
• If a snippet only works for newer versions of Lucee or Adobe - [Lucee 5.3+], [ACF2018+]

I propose adding an engine: [] array to the snippet JSON files and ES document schema. We can add a simple array of values, loop over them in the HTML, and style each with a button or pill style.