publish recipes on lucee docs (#1460)

* publish recipes on lucee docs * Update recipes index and README * linting * Update logging.md * Update recipes index and README --------- Co-authored-by: Lucee Docs GitHub Action <[email protected]>
lucee · Jan 17, 2025 · a48dbfe · a48dbfe
1 parent 136ed71
commit a48dbfe
Show file tree

Hide file tree

Showing 35 changed files with 80 additions and 1,595 deletions.
diff --git a/api/data/DocTree.cfc b/api/data/DocTree.cfc
@@ -311,10 +311,17 @@ component accessors=true {
 						variables.tree.append(guide);
 					}
 					break;
-				/*	
 				case "recipes":
+					var recipeTree = folder.getChildren();
+					for (var recipe in recipeTree){
+						if (recipe.getForceSortOrder() gt 0){
+							recipe.setSortOrder(recipe.getForceSortOrder());
+						} else {
+							recipe.setSortOrder(5 + NumberFormat(recipe.getSortOrder()/100,"0.00"));
+						}
+						variables.tree.append(recipe);
+					}
 					break;
-				*/
 			}
 		}
 		_sortChildren( variables.tree );

diff --git a/api/data/PageCache.cfc b/api/data/PageCache.cfc
@@ -83,7 +83,7 @@ component accessors=true {
 				var timestamp = CreateDate(2000,1,1);//
 				for( var file in local.files){
 					file = _removeRootDirectoryFromFilePath(file);
-					if ( ListFirst( file, "/" ) eq "recipes") continue;
+					// if ( ListFirst( file, "/" ) eq "recipes") continue;
 					var row = QueryAddRow(local.q_files);
 					querySetCell(local.q_files, "name", ListLast(file, "/") , row);
 					querySetCell(local.q_files, "fullpath", file , row);

diff --git a/api/data/PageReader.cfc b/api/data/PageReader.cfc
@@ -50,11 +50,17 @@ component {
 			if (page.getPageType() eq "README"){
 				page.setPath( page.getPath() );
 				page.setPageType( "listing" );
+				page.setListingStyle( "flat" );
 				page.setVisible( true );
-				page.setReference( false );
-				page.setBody( "Recipes" );
+				page.setReference( true );
+				page.setBody( "Detailed Recipes showing you how to take advantage of the wide range of features in Lucee" );
+				page.setMenuTitle( "Recipes" );
 				page.setTitle( "Lucee Recipes" );
-				page.setDescription( "Lucee Recipes" );
+				page.setDescription( "Detailed Recipes showing you how to take advantage of the wide range of features in Lucee" );
+				page.setForceSortOrder( 5.5 );
+				page.setSortOrder( 4.5 );
+				page.setSlug("recipes");
+				page.setId("recipes");
 			} else {
 				page.setPath( page.getPath() & "/" & replace( page.getPageType(), ".md", "" ) );
 				page.setPageType( "page" );
@@ -149,7 +155,6 @@ component {
 		} else if ( len( trim( arguments.pageContent ) ) ){
 			parsed = _splitCommentStructAndBody( arguments.pageContent, arguments.filePath );
 		}
-
 		return parsed;
 	}
 
@@ -194,10 +199,9 @@ component {
 		var body = mid( str, endComment + 3 );
 		if ( len( trim( body ) ) eq 0 )
 			throw "empty content after metadata [#arguments.filePath#]";
-		return {
-			  yaml = deserializeJson( meta )
-			, body = body
-		}
+		meta = deserializeJson( meta );
+		meta.body = body;
+		return meta;
 	}
 
 	private string function _convertToUnixLineEnding( required string content ){

diff --git a/builders/html/templates/aToZIndex.cfm b/builders/html/templates/aToZIndex.cfm
@@ -9,8 +9,7 @@
 <cfoutput>
 	#getEditLink(path=local.pg.getSourceFile(), edit=args.edit)#
 	#_markdownToHtml( local.pg.getBody() )#
-
-	<cfif ArrayLen(local.pg.getChildren()) lt 50>
+	<cfif ArrayLen(local.pg.getChildren()) lt 50 or local.pg.getListingStyle() eq "flat">
 		<div class="tile-wrap">
 			<cfloop array="#local.pg.getChildren()#" index="local.i" item="local.child">
 				<span class="tile">

diff --git a/docs/00.home/homepage.md b/docs/00.home/homepage.md
@@ -16,9 +16,13 @@ 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)
 
+## Recipes 
+
+**New!** We have added a whole series of detailed [[Recipes]] showing you how to take advantage of the wide range of features in Lucee.
+
 ## 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.2 is our upcoming next major release, currently at the Release Candidate stage, including enhanced Java and Maven integration, with even better runtime performance, up to 50% faster than Lucee 5.4.
 
 ## Lucee 6.1
 

diff --git a/docs/04.guides/04.cookbooks/04.basic-date/page.md b/docs/04.guides/04.cookbooks/04.basic-date/page.md
diff --git a/docs/04.guides/04.cookbooks/11.configuration-administrator-cfc/page.md b/docs/04.guides/04.cookbooks/11.configuration-administrator-cfc/page.md
diff --git a/...04.cookbooks/12.filesystem-mapping/01.filesystem-mapping-define-mapping/page.md b/...04.cookbooks/12.filesystem-mapping/01.filesystem-mapping-define-mapping/page.md
diff --git a/docs/04.guides/04.cookbooks/12.filesystem-mapping/page.md b/docs/04.guides/04.cookbooks/12.filesystem-mapping/page.md
diff --git a/docs/04.guides/04.cookbooks/14.check-for-changes/page.md b/docs/04.guides/04.cookbooks/14.check-for-changes/page.md