Merge pull request #3036 from tinymce/staging/docs-6

DOC-2233: Merge `staging/docs-6` into `release/docs-6` for latest build site.

Author: kemister85

-scripts/generate-site.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+PLAYBOOK="$1"
+
+
+BUILD_DIR="build"
+SITE_DIR="$BUILD_DIR/site/tinymce"
+
+SOURCE_VERSION="latest"
+SOURCE_DIR="$SITE_DIR/$SOURCE_VERSION/"
+DEST_VERSION=6
+DEST_DIR="$SITE_DIR/$DEST_VERSION/"
+
+echo -e "\nRemoving existing $SITE_DIR directory."
+rm -rf "$BUILD_DIR"
+
+echo -e "\nGenerating antora documentation."
+antora "$PLAYBOOK"
+
+echo -e "\nCopying all $SOURCE_VERSION content to $DEST_VERSION directory."
+mkdir "$DEST_DIR"
+
+cp -a "$SOURCE_DIR." "$DEST_DIR"
+
+echo "$DEST_VERSION site now in sync with $SOURCE_VERSION."

.github/workflows/feature_6_docs.yml

@@ -34,7 +34,7 @@ jobs:
       run: yarn build
 
     - name: (Feature - Docs 6) Build Website
-      run: yarn antora ./antora-playbook-dev.yml
+      run: yarn generate-site ./antora-playbook-dev.yml
 
     - name: (deploy) Prepare for branch deployments
       shell: bash

.github/workflows/release_6_docs.yml

@@ -33,7 +33,7 @@ jobs:
       run: yarn build
 
     - name: (Release - Docs 6) Build Website
-      run: yarn antora ./antora-playbook-prod.yml
+      run: yarn generate-site ./antora-playbook-prod.yml
 
     - name: (Release - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
       shell: bash

.github/workflows/staging_6_docs.yml

@@ -33,7 +33,7 @@ jobs:
       run: yarn build
 
     - name: (Staging - Docs 6) Build Website
-      run: yarn antora ./antora-playbook-staging.yml
+      run: yarn generate-site ./antora-playbook-staging.yml
 
     - name: (Staging - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
       shell: bash

antora.yml

@@ -1,6 +1,7 @@
 name: tinymce
 title: TinyMCE Documentation
-version: '6'
+version: 'latest'
+display_version: '6'
 asciidoc:
   attributes:
     # anchor configuration (the @ allows it to be overridden if required)
@@ -18,7 +19,7 @@ asciidoc:
     # product variables
     productname: TinyMCE
     productmajorversion: 6
-    productminorversion: '6.6'
+    productminorversion: '6.8'
     ##### product name in codeblock
     prodnamecode: tinymce
     #### more names

changelog.md

@@ -6,6 +6,10 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/
 
 ### Unreleased
 
+### 2023-12-19
+
+- DOC-2220: add generation of `latest` and `6` documentation in parallel.
+
 ### 2023-12-13
 
 - DOC-2225: added `6.8.2-release-notes.adoc` to project; updated `changelog.adoc`, `nav.adoc` and `release-notes.adoc` for the TinyMCE 6.8.2 release.

modules/ROOT/pages/6.4.1-release-notes.adoc

@@ -598,7 +598,7 @@ As a result the when the instance occurs where **no <string> match** is triggere
 === Color picker on toolbar would not update when changing forecolor or backcolor from menu
 //#TINY-9439
 
-In {productname} 6.3, when the https://www.tiny.cloud/docs/tinymce/6/6.3-release-notes/#new-color_map_foreground-and-color_map_background-options-store-custom-colors-selected-using-the-text-color-and-background-color-menus[new color map] was introduced, a regression was found that affected the UI for *Color Swatch*.
+In {productname} 6.3, when the xref:6.3-release-notes.adoc#new-color_map_foreground-and-color_map_background-options-store-custom-colors-selected-using-the-text-color-and-background-color-menus[new color map] was introduced, a regression was found that affected the UI for *Color Swatch*.
 
 The issue occurred when a user would select a `forecolor` or `backcolor` via the `*Formats*` drop down menu, the color displayed on the color swatch toolbar buttons would not reflect the selected `forecolor` or `backcolor` respectively.
 
@@ -623,7 +623,7 @@ In {productname} 6.4.1, changes were made to prevent descendants of an element w
 === Checkmark did not show in menu color swatches
 //#TINY-9395
 
-Previous versions of {productname} the known issue, (_https://www.tiny.cloud/docs/tinymce/6/6.3-release-notes/#checkmark-over-the-current-background-color-is-not-displayed-when-inline-formatting-is-applied-in-a-certain-order[checkmark-over-the-current-background-color-is-not-displayed-when-inline-formatting-is-applied-in-a-certain-order]_) was identified. As a consequence, when text was formatted in the following order, the *checkmark* over the currently active background color would not display in the Background color swatch menu:
+Previous versions of {productname} the known issue, xref:6.3-release-notes.adoc#checkmark-over-the-current-background-color-is-not-displayed-when-inline-formatting-is-applied-in-a-certain-order[_checkmark over the current background color is not displayed when inline formatting is applied in a certain order_] was identified. As a consequence, when text was formatted in the following order, the *checkmark* over the currently active background color would not display in the Background color swatch menu:
 
 . When the user applied inline formatting, such as *bold* or _Italic_.
 . After applying a foreground(text) color.

modules/ROOT/pages/6.7.3-release-notes.adoc

@@ -23,9 +23,9 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[]
 
 A https://researchgate.net/publication/266654651_mXSS_attacks_Attacking_well-secured_web-applications_by_using_innerHTML_mutations[mutation cross-site scripting] (mXSS) vulnerability was discovered in {productname}’s core undo/redo functionality and other APIs and plugins. Text nodes within specific parents are not escaped upon serialization according to the https://html.spec.whatwg.org/multipage/parsing.html#serialising-html-fragments[HTML standard]. If such text nodes contain a special character reserved as an internal marker, they can be combined with other HTML patterns to form malicious snippets. These snippets pass the initial sanitization layer when the content is parsed into the editor body, but can trigger XSS when the special internal marker is removed from the content and re-parsed. Such mutations occur when serialized HTML content is processed before being stored in the undo stack, or when the following APIs and plugins are used:
 
-* https://tiny.cloud/docs/tinymce/6/apis/tinymce.editor/#getContent[tinymce.Editor.getContent({ format: 'raw' })]
-* https://tiny.cloud/docs/tinymce/6/apis/tinymce.editor/#resetContent[tinymce.Editor.resetContent()]
-* https://tiny.cloud/docs/tinymce/6/autosave/[Autosave Plugin]
+* xref:apis/tinymce.editor.adoc#getContent[tinymce.Editor.getContent({ format: 'raw' })]
+* xref:apis/tinymce.editor.adoc#resetContent[tinymce.Editor.resetContent()]
+* xref:autosave.adoc[Autosave Plugin]
 
 This vulnerability has been patched in {productname} 6.7.3 by:
 

modules/ROOT/pages/6.8.1-release-notes.adoc

@@ -29,7 +29,7 @@ The {productname} 6.8.1 release includes an accompanying release of the **Advanc
 
 **Advanced Templates** 1.4.0 includes the following improvement and fix.
 
-==== New `{{mce-clipboard}}` marker as a placeholder within template content, indicating the location where clipboard content will be inserted
+==== New `{\{mce-clipboard\}}` marker as a placeholder within template content, indicating the location where clipboard content will be inserted
 // #TINY-9974
 **Advanced Template** 1.4.0 introduces a new feature that allows templates to now include special markers, denoted as `+{{mce-clipboard}}+`. These markers serve as placeholders that indicate where clipboard content should be inserted once the template is added to the editor's content.
 
@@ -61,7 +61,7 @@ As a result, when a user inserts a template containing the `+{{mce-clipboard}}+`
 
 NOTE: when the host browser is **FireFox**, the user will be prompted with a notification error, as it currently does not support clipboard reading.
 
-==== The functionality of the `{{mce-cursor}}` marker feature was broken after the upgrade to {productname} 6.7.3
+==== The functionality of the `{\{mce-cursor\}}` marker feature was broken after the upgrade to {productname} 6.7.3
 // #TINY-10367
 Security patch for {productname} 6.7.3, made changes to **ZWNBSP** characters so they are now removed from any content passed via the `insertContent` API. **ZWNBSP** characters were used to add padding to the marker to avoid it cleaning out the empty content.
 
@@ -540,7 +540,7 @@ As a result, the `width` of the buttons now display correctly.
 // #TINY-10174
 In earlier versions of {productname}, collection items set in a xref:dialog-components.adoc#collection[collection dialog component] would not display any icon as set in the `+icon+` property, instead only displaying the `+string+` itself.
 
-In {productname} 6.8.1, dialog collection items will now use any specified `+icon+` from the xref:icons.adoc#icons[icon pack], with the `+string+` itself used in the case where no such icon exists. This is the current behaviour, as in most uses of dialog collections in {productname}, the `+icon+` property is set as an individual character, such as in the xref:emoticons.adoc[Emoticons] and xref:charmap.adoc[Charmap] plugins.
+In {productname} 6.8.1, dialog collection items will now use any specified `+icon+` from the xref:editor-icons.adoc#icons[icon pack], with the `+string+` itself used in the case where no such icon exists. This is the current behaviour, as in most uses of dialog collections in {productname}, the `+icon+` property is set as an individual character, such as in the xref:emoticons.adoc[Emoticons] and xref:charmap.adoc[Charmap] plugins.
 
 For information on the **Dialog layout components for collections** plugin see xref:dialog-components.adoc#collection[dialog components].
 

package.json

@@ -8,9 +8,10 @@
   },
   "homepage": "https://www.tiny.cloud/docs/",
   "scripts": {
-    "nodemon-dev": "nodemon --exec antora ./antora-playbook-dev.yml",
     "build": "./-scripts/api-reference.sh",
     "build-local-ref": "./-scripts/api-reference-local.sh",
+    "generate-site": "./-scripts/generate-site.sh",
+    "nodemon-dev": "nodemon --exec yarn generate-site ./antora-playbook-dev.yml",
     "server": "http-server build/site/ --port 4000",
     "serve": "npm-run-all -p nodemon-dev server"
   },