DOC-2236: Update 5 docs site, workflows, warnings, errors, api docs (#3058)

* DOC-2236: Bring 5 docs changes to new site

* DOC-2236: Fix assorted issues

* DOC-2236: Update to new legacy API docs

* DOC-2236: Update node version

* DOC-2236: Update 5 workflow to build with CSS

* DOC-2236: Update local api reference script

* DOC-2236: Fix reference formatting

* DOC-2236: Sync images in workflows

* DOC-2236: Fix review suggestions

* DOC-2236: Remove unnecessary sitemap rename

Author: MitchC1999

.github/workflows/feature_5_docs.yml

@@ -12,11 +12,11 @@ on:
 jobs:
   build:
     name: Build Docs and Deploy
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        node-version: [14]
+        node-version: [21]
 
     steps:
     - uses: actions/checkout@v1
@@ -56,7 +56,7 @@ jobs:
         echo $S3_BUCKET > S3_BUCKET
 
     - name: (deploy) Upload website to S3
-      run: aws s3 sync --acl=public-read --delete ./build/site $(cat S3_BUCKET)/docs --exclude '*' --include 'tinymce/5/*'
+      run: aws s3 sync --acl=public-read --delete ./build/site $(cat S3_BUCKET)/docs
       env:
         AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}

.github/workflows/release_5_docs.yml

@@ -11,11 +11,11 @@ on:
 jobs:
   build:
     name: Build Docs and Deploy
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        node-version: [14]
+        node-version: [21]
 
     steps:
     - uses: actions/checkout@v1
@@ -35,17 +35,19 @@ jobs:
     - name: (Release - Docs 5) Build Website
       run: yarn antora ./antora-playbook-prod.yml
 
-    - name: (Release - Docs 5) Rename sitemap.xml
-      shell: bash
-      run: |
-        mv ./build/site/sitemap.xml ./build/site/antora-5-sitemap.xml
-
     - name: (deploy) Upload to S3
       run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude '*' --include 'tinymce/5/*'
       env:
         AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
         AWS_EC2_METADATA_DISABLED: true
+      
+    - name: (deploy) Upload images to S3
+      run: aws s3 sync --acl=public-read ./build/site/_ s3://tiny-cloud-antora-docs-production/docs/_ --exclude '*' --include 'img'
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
+        AWS_EC2_METADATA_DISABLED: true
 
     - name: (deploy) Invalidate Cache
       run: aws cloudfront create-invalidation --distribution-id E3LFU502SQ5UR --paths "/docs/*"

.github/workflows/staging_5_docs.yml

@@ -11,11 +11,11 @@ on:
 jobs:
   build:
     name: Build Docs and Deploy
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        node-version: [14]
+        node-version: [21]
 
     steps:
     - uses: actions/checkout@v1
@@ -35,17 +35,19 @@ jobs:
     - name: (Staging - Docs 5) Build Website
       run: yarn antora ./antora-playbook-staging.yml
 
-    - name: (Staging - Docs 6) Rename sitemap.xml
-      shell: bash
-      run: |
-        mv ./build/site/sitemap.xml ./build/site/antora-5-sitemap.xml
-
     - name: (deploy) Upload to S3
       run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude '*' --include 'tinymce/5/*'
       env:
         AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
         AWS_EC2_METADATA_DISABLED: true
+      
+    - name: (deploy) Upload images to S3
+      run: aws s3 sync --acl=public-read ./build/site/_ s3://tiny-cloud-antora-docs-staging/docs/_ --exclude '*' --include 'img'
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
+        AWS_EC2_METADATA_DISABLED: true
 
     - name: (deploy) Invalidate Cache
       run: aws cloudfront create-invalidation --distribution-id E7DUUPEI08HNW --paths "/docs/*"

.gitignore

@@ -11,4 +11,4 @@ _site/
 
 # Moxiedoc files
 moxiedoc_nav.adoc
-modules/ROOT/pages/apis/
+modules/ROOT/pages/api/

README.md

@@ -1,7 +1,5 @@
 # TinyMCE documentation
 
-[![wercker status](https://app.wercker.com/status/4d4c743635332430f9d25acae1be5218/s/main "wercker status")](https://app.wercker.com/project/bykey/4d4c743635332430f9d25acae1be5218)
-
 This project maintains the documentation for TinyMCE at
 [https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). If you have any
 modifications you wish to contribute, fork this project, make the changes

_new_content_templates/blank_releasenotes.adoc

@@ -25,19 +25,19 @@ The following "list" should be added to `data/nav.yml`
 
 == Overview
 
-{productname} vnumtxt was released for {enterpriseversion} and {cloudname} on <<`WEEKDAY`, `MMM` `D`^`st|nd|th`^, `YYYY`>>. It includes {productname} vnumtxt and additional changes to premium plugins. These release notes provide an overview of the changes for {productname} vnumtxt, including:
-
-* <<newfeatures,New features>>
-* <<enhancements,Enhancements>>
-* <<functionalitychanges,Functionality changes>>
-* <<accompanyingpremiumpluginchanges,Accompanying Premium Plugin changes>>
-* <<accompanyingpremiumskinsandiconpackschanges,Accompanying Premium Skins and Icon Packs changes>>
-* <<accompanyingpremiumself-hostedserver-sidecomponentchanges,Accompanying Premium self-hosted server-side component changes>>
-* <<generalbugfixes,General bug fixes>>
-* <<securityfixes,Security fixes>>
-* <<deprecatedfeatures,Deprecated features>>
-* <<knownissues,Known issues>>
-* <<upgradingtothelatestversionoftinymce5,Upgrading to the latest version of TinyMCE 5>>
+{productname} vnumtxt was released for {enterpriseversion} and {cloudname} on +`WEEKDAY`, `MMM` `D`^`st|nd|th`^, `YYYY`+ It includes {productname} vnumtxt and additional changes to premium plugins. These release notes provide an overview of the changes for {productname} vnumtxt, including:
+
+* xref:newfeatures[New features]
+* xref:enhancements[Enhancements]
+* xref:functionalitychanges[Functionality changes]
+* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium Plugin changes]
+* xref:accompanyingpremiumskinsandiconpackschanges[Accompanying Premium Skins and Icon Packs changes]
+* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
+* xref:general-bug-fixes[General bug fixes]
+* xref:security-fixes[Security fixes]
+* xref:deprecatedfeatures[Deprecated features]
+* xref:knownissues[Known issues]
+* xref:upgrading-to-the-latest-version-of-tinymce-5[Upgrading to the latest version of TinyMCE 5]
 
 include::partial$misc/releasenotes_for_stable.adoc[]
 
@@ -77,21 +77,21 @@ The following premium plugin updates were released alongside {productname} vnumt
 
 === Premium Plugin Name X.Y.Z
 
-The {productname} vnumtxt release includes an accompanying release of the *<<Premium Plugin Name>>* premium plugin.
+The {productname} vnumtxt release includes an accompanying release of the *Premium Plugin Name* premium plugin.
 
-*<<Premium Plugin Name>>* X.Y.Z adds the following new features:
+*Premium Plugin Name* X.Y.Z adds the following new features:
 
 * {blank}+++<Description>++++++</Description>+++
 
-*<<Premium Plugin Name>>* X.Y.Z introduces the following enhancements:
+*Premium Plugin Name* X.Y.Z introduces the following enhancements:
 
 * {blank}+++<Description>++++++</Description>+++
 
-*<<Premium Plugin Name>>* X.Y.Z provides the following bug fixes:
+*Premium Plugin Name* X.Y.Z provides the following bug fixes:
 
 * {blank}+++<Description>++++++</Description>+++
 
-For information on the <<Premium Plugin Name>> plugin, see: link:{baseurl}/plugins/<<Premium Plugin Name>>/[<<Premium Plugin Name>> plugin].
+For information on the Premium Plugin Name plugin, see: xref:plugins/pluginname.adoc[Premium Plugin Name plugin].
 
 == Accompanying Premium Skins and Icon Packs changes
 
@@ -103,7 +103,7 @@ The {productname} vnumtxt release includes an accompanying release of the *Premi
 Add description here.
 ////
 
-For information on using premium skins and icon packs, see: link:{baseurl}/enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
+For information on using premium skins and icon packs, see: xref:enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
 
 === Premium Skins and Icon Packs - Bug fixes
 
@@ -113,9 +113,9 @@ The *Premium Skins and Icon Packs* release includes the following bug fixes:
 Add description here.
 ////
 
-For information on using premium skins and icon packs, see: link:{baseurl}/enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
+For information on using premium skins and icon packs, see: xref:enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
 
-[[accompanyingpremiumself-hostedserver-sidecomponentchanges]]
+[[accompanying-premium-self-hosted-server-side-component-changes]]
 == Accompanying Premium self-hosted server-side component changes
 
 The {productname} vnumtxt release includes accompanying changes affecting the {productname} *self-hosted* services for the following plugins:
@@ -132,15 +132,15 @@ The Java server-side components have been updated to the following versions:
 * `ephox-hyperlinking.war`: X.Y.Z
 * `ephox-image-proxy.war`: X.Y.Z
 
-This version requires Java 8 or higher. For information on the removal of Java 7 support, see: link:{baseurl}/release-notes/release-notes53/#removalofjava7support[Removal of Java 7 support for TinyMCE 5.3 and later].
+This version requires Java 8 or higher. For information on the removal of Java 7 support, see: xref:release-notes/release-notes53/#removalofjava7support[Removal of Java 7 support for TinyMCE 5.3 and later].
 
 For information on:
 
-* The Spell Checker Pro plugin, see: link:{baseurl}/plugins/premium/tinymcespellchecker/[Spell Checker Pro plugin].
-* The Link Checker plugin, see: link:{baseurl}/plugins/premium/linkchecker/[Link Checker plugin].
-* The Image Tools plugin, see: link:{baseurl}/plugins/opensource/imagetools/[Image Tools plugin].
-* The Enhanced Media Embed plugin, see: link:{baseurl}/plugins/premium/mediaembed/[Enhanced Media Embed plugin].
-* Deploying the server-side components, see: link:{baseurl}/enterprise/server/[Server-side component installation].
+* The Spell Checker Pro plugin, see: xref:plugins/premium/tinymcespellchecker/[Spell Checker Pro plugin].
+* The Link Checker plugin, see: xref:plugins/premium/linkchecker/[Link Checker plugin].
+* The Image Tools plugin, see: xref:plugins/opensource/imagetools/[Image Tools plugin].
+* The Enhanced Media Embed plugin, see: xref:plugins/premium/mediaembed/[Enhanced Media Embed plugin].
+* Deploying the server-side components, see: xref:enterprise/server/[Server-side component installation].
 
 === Updating the self-hosted server-side components
 
@@ -157,8 +157,8 @@ The new versions of the server-side services provide updates for the Java-based
 
 For information on:
 
-* Deploying the server-side components, see: link:{baseurl}/enterprise/server/[Server-side component installation].
-* Deploying the server-side components using Docker, see: link:{baseurl}/enterprise/server/dockerservices/[Containerized service deployments].
+* Deploying the server-side components, see: xref:enterprise/server/[Server-side component installation].
+* Deploying the server-side components using Docker, see: xref:enterprise/server/dockerservices/[Containerized service deployments].
 
 == General bug fixes
 
@@ -176,17 +176,17 @@ For information on:
 
 The following features have been deprecated with the release of {productname} vnumtxt:
 
-* <<,>>.
+* xref:placeholder[placeholder].
 
 === The...
 
 == Known issues
 
 This section describes issues that users of {productname} vnumtxt may encounter and possible workarounds for these issues.
 
-* <<,>>
+* xref:placeholder[placeholder].
 
-=== ,
+=== placeholder
 
 Issue:: This issue affects ....
 

_scripts/api-reference-local.sh

@@ -14,17 +14,17 @@ echo -e "\n > importing data files for tinymce api reference: local from $1\n"
 
 rm -rf "$API_TMPDIR"
 mkdir "$API_TMPDIR"
-npx moxiedoc "$1/modules/tinymce/src/core/main/ts" -t antora -o "$API_TMPDIR/tinymce-api-reference.zip"
+npx moxiedoc "$1/modules/tinymce/src/core/main/ts" -t antora -s "legacy" -o "$API_TMPDIR/tinymce-api-reference.zip"
 unzip -o "$API_TMPDIR/tinymce-api-reference.zip"
 
 # remove old api adoc pages
-rm -rf modules/ROOT/pages/apis/
+rm -rf modules/ROOT/pages/api/
 
 # removed old static api html pages (clear cache), it can corrupt the build
-rm -rf build/site/_/tinymce/6.0/apis/
+rm -rf build/site/tinymce/5/api/
 
 # move newly generated adoc pages, antora will then generate new static html pages
-mv _data/antora modules/ROOT/pages/apis
+mv _data/antora/api modules/ROOT/pages
 
 # move api navigation
 mv _data/moxiedoc_nav.adoc modules/ROOT/moxiedoc_nav.adoc

_scripts/api-reference.sh

@@ -13,17 +13,17 @@ rm -rf _data
 rm -rf "$API_TMPDIR"
 mkdir "$API_TMPDIR"
 curl -s "$TARBALL_URL" | tar xzf - -C "$API_TMPDIR" --strip-components 1
-npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -o "$API_TMPDIR/tinymce-api-reference.zip"
+npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -s "legacy" -o "$API_TMPDIR/tinymce-api-reference.zip"
 unzip -o "$API_TMPDIR/tinymce-api-reference.zip"
 
 # remove old api adoc pages
-rm -rf modules/ROOT/pages/apis/
+rm -rf modules/ROOT/pages/api/
 
 # removed old static api html pages (clear cache), it can corrupt the build
-rm -rf build/site/_/tinymce/6.0/apis/
+rm -rf build/site/tinymce/5/api/
 
 # move newly generated adoc pages, antora will then generate new static html pages
-mv _data/antora modules/ROOT/pages/apis
+mv _data/antora/api modules/ROOT/pages/
 
 # move api navigation
 mv _data/moxiedoc_nav.adoc modules/ROOT/moxiedoc_nav.adoc

antora-playbook-dev.yml

@@ -1,5 +1,5 @@
 site:
-  title: TinyMCE Documentation (Dev)
+  title: TinyMCE 5 Documentation (Dev)
   url: https://www.tiny.cloud/docs
   start_page: tinymce::index.adoc
 content:

antora-playbook-prod.yml

@@ -1,5 +1,5 @@
 site:
-  title: TinyMCE Documentation
+  title: TinyMCE 5 Documentation
   url: https://www.tiny.cloud/docs
   start_page: tinymce::index.adoc
 content: