From fda17b9267273fa8ee252689873c88c7784cde39 Mon Sep 17 00:00:00 2001 From: Lucee Docs GitHub Action Date: Wed, 6 Nov 2024 18:47:18 +0000 Subject: [PATCH 01/16] Update recipes index and README --- docs/recipes/index.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/recipes/index.json b/docs/recipes/index.json index e18d2815b..3221be4e3 100644 --- a/docs/recipes/index.json +++ b/docs/recipes/index.json @@ -266,7 +266,7 @@ "file": "environment-variables-system-properties.md", "title": "Environment Variables / System Properties for Lucee", "path": "/docs/recipes/environment-variables-system-properties.md", - "hash": "22bd4b36e76ff5194319cfaf24a62804", + "hash": "ab594b0f78fc2d3cb133554e60c3fb09", "keywords": [ "Environment", "Environment Variables", From 55c095e36ac72ea4bcb979b0c8aabbba76243958 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Thu, 7 Nov 2024 13:29:19 +0100 Subject: [PATCH 02/16] add note about 5.4 only supporting java 8 and 11 --- docs/00.home/homepage.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/00.home/homepage.md b/docs/00.home/homepage.md index ee4998c6b..970ce8434 100644 --- a/docs/00.home/homepage.md +++ b/docs/00.home/homepage.md @@ -32,7 +32,9 @@ As a Major Release, Lucee 6 does include some potential **BREAKING CHANGES**, fo ## Lucee 5.4 (LTS) -Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs. +Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs. + +Only Java 8 and 11 are supported, there are various changes in Java 21 including date time handling which are not addressed in 5.4, time to upgrade! As a LTS release, Lucee 5.4 will receive security updates and critical regression fixes until 2026, **but is no longer actively maintained.** From 8a68352401a937bf695b3d254faa1a500cd1cd4e Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Fri, 8 Nov 2024 11:36:48 +0100 Subject: [PATCH 03/16] Update homepage.md --- docs/00.home/homepage.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/00.home/homepage.md b/docs/00.home/homepage.md index 970ce8434..f03f6160c 100644 --- a/docs/00.home/homepage.md +++ b/docs/00.home/homepage.md @@ -16,11 +16,16 @@ Our documentation is an open source and community driven effort. It is also a co To find out more about getting involved as a developer with Lucee, checkout our [Git Repo](https://github.com/lucee/Lucee/blob/6.0/CONTRIBUTING.md) +## Lucee 6.2 + +Lucee 6.2 is our upcoming next major release, including enhanced Java and Maven integration, with even better runtime performance. + ## Lucee 6.1 Lucee 6.1 is current stable release of Lucee. -Targeting better performance and reduced memory usuage, Lucee 6.1 has full support for Java 11 and 21. +Targeting better performance and reduced memory usage, Lucee 6.1 introduces full support for Java 17 and 21, as well as Java 11. +Java 8 is no longer officially supported. ## Lucee 6.0 @@ -32,7 +37,7 @@ As a Major Release, Lucee 6 does include some potential **BREAKING CHANGES**, fo ## Lucee 5.4 (LTS) -Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs. +Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs. Only Java 8 and 11 are supported, there are various changes in Java 21 including date time handling which are not addressed in 5.4, time to upgrade! @@ -45,7 +50,7 @@ As a LTS release, Lucee 5.4 will receive security updates and critical regressio ## Lucee 5.3 -Lucee 5.3 (and older) now is no longer actively developed. It's time to upgrade to 5.4 LTS or 6 (reommended) +Lucee 5.3 (and older) now is no longer actively developed. It's time to upgrade to 5.4 LTS or 6 (recommended) ## Lucee 4.5 From e4c5954ec5ea777aa5c2ced118aeef9cff4bcda8 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sun, 10 Nov 2024 12:38:38 +0100 Subject: [PATCH 04/16] use a better sort order for sub categories (mainly, list functions before member functions) --- builders/html/templates/category.cfm | 42 ++++++++++++++---------- docs/05.categories/090.esapi/category.md | 5 +-- 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/builders/html/templates/category.cfm b/builders/html/templates/category.cfm index cab6315bd..802465090 100644 --- a/builders/html/templates/category.cfm +++ b/builders/html/templates/category.cfm @@ -8,13 +8,22 @@ local.pages = args.docTree.sortPagesByType( local.pages ); local.currentPageType = ""; - local.pageTypeTitles = { - "function" = "Functions", - "_method" = "Methods", - "_object" = "Objects", - "tag" = "Tags", - "category" = "Categories", - }; + local.pageTypeTitles = [ + "function" = { title="Functions", pages=0 }, + "tag" = { title="Tags", pages=0 }, + "_method" = { title="Methods", pages=0 }, + "_object" = { title="Objects", pages=0 }, + "category" = { title="Categories", pages=0 }, + "page" = { title="Guides",pages=0 } + ]; + + local.missingPageTypes = {}; + loop array="#local.pages#" index="local.i" item="local.page" { + if ( !structKeyExists(local.pageTypeTitles, local.page.getPageType() ) ) { + throw "Unknown page type: [ #local.page.getPageType()# ]"; + } + local.pageTypeTitles[local.page.getPageType()].pages++; + } @@ -25,18 +34,17 @@

There are no pages tagged with this category.

- - - - - - -

#( local.pageTypeTitles[ local.page.getPageType() ] ?: "Guides" )#

+ + +

#( local.pageType.title )#

    + + +
  • [[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#
    • +     +     +
- -
  • [[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#
    •  -     \ No newline at end of file diff --git a/docs/05.categories/090.esapi/category.md b/docs/05.categories/090.esapi/category.md index 455c7764f..17683a51f 100644 --- a/docs/05.categories/090.esapi/category.md +++ b/docs/05.categories/090.esapi/category.md @@ -1,7 +1,8 @@ --- title: Encode/Decode id: category-esapi -related: +categories: +- category-core --- -Enterprise Security API +Used to prevent XSS, these functions use the ESAPI (Enterprise Security API) library to safely handle user input. From 4358a91e345e1d48e9ca8f73b43e048ff9a02938 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sun, 10 Nov 2024 12:45:55 +0100 Subject: [PATCH 05/16] fix markdown linting errors --- docs/recipes/ai-for-documentation.md | 1 + docs/recipes/ai.md | 7 ++++++- docs/recipes/breaking-changes-6-1.md | 15 +++++++++++---- docs/recipes/configuration-lucee5.md | 1 + docs/recipes/configuration.md | 2 ++ docs/recipes/overwrite-build-in-functions-tags.md | 1 - 6 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/recipes/ai-for-documentation.md b/docs/recipes/ai-for-documentation.md index ec55f9a20..06985dcf8 100644 --- a/docs/recipes/ai-for-documentation.md +++ b/docs/recipes/ai-for-documentation.md @@ -38,6 +38,7 @@ To enable AI in the Documentation tab of the Monitor, set up a compatible AI con Below are example configurations to enable AI functionality in the Documentation tab, important here is the `default` setting. **OpenAI (ChatGPT) Configuration Example:** + ```json "ai": { "docChatGPT": { diff --git a/docs/recipes/ai.md b/docs/recipes/ai.md index a677d20e2..25a776aff 100644 --- a/docs/recipes/ai.md +++ b/docs/recipes/ai.md @@ -19,6 +19,7 @@ Lucee 6.2 includes experimental support for AI integration, which will be finali In Lucee 6.2, AI connections can be configured similarly to datasources or caches, either in the Lucee Administrator or directly in `.CFConfig.json`. Here are sample configurations: **OpenAI (ChatGPT) Example:** + ```json "ai": { "mychatgpt": { @@ -36,6 +37,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache ``` **Google Gemini Example:** + ```json "ai": { "mygemini": { @@ -51,6 +53,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache ``` **Ollama (Local) Example:** + ```json "ai": { "gemma2": { @@ -68,6 +71,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache In these examples, ChatGPT from OpenAI, Gemini from Google, and Ollama for local use are set up. The `OpenAIEngine` allows configuration for `openai` or `ollama` types and can also connect to any service using the OpenAI REST interface by specifying a URL: **OpenAI REST Interface Example:** + ```json "ai": { "lucy": { @@ -110,6 +114,7 @@ You can interact with AI directly via Lucee functions and tags. At the moment, these functions use the prefix `Lucee` to avoid conflicts with existing functions in your code. With Lucee 7, we plan to remove the prefix (but still support it as an alias). **Direct Interaction Example:** + ```javascript // start a session with a specic AI endpoint slim = LuceeCreateAISession(name:'gemma2', systemMessage:"Answer as Slim Shady."); @@ -136,7 +141,7 @@ This feature is still a work in progress, and we are working to improve the qual ### Monitor Documentation Tab In the Monitor's Documentation tab, AI can answer questions about Lucee based on retrieval-augmented generation (RAG) with available documentation and links to related documents. -This feature is also in development for enhanced input quality (read more about Monitor Documentation here https://github.com/lucee/lucee-docs/blob/master/docs/recipes/monitoring-debugging.md). +This feature is also in development for enhanced input quality (read more about [https://github.com/lucee/lucee-docs/blob/master/docs/recipes/monitoring-debugging.md](Monitor Documentation) ). ## Future Development diff --git a/docs/recipes/breaking-changes-6-1.md b/docs/recipes/breaking-changes-6-1.md index 0246dcf2c..92a3784e8 100644 --- a/docs/recipes/breaking-changes-6-1.md +++ b/docs/recipes/breaking-changes-6-1.md @@ -1,5 +1,4 @@ -