Skip to content

Commit

Permalink
DOC-2220: Build site script
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchC1999 committed Dec 11, 2023
1 parent 63f2854 commit 568350a
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 6 deletions.
22 changes: 22 additions & 0 deletions -scripts/generate-site.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/bin/bash

PLAYBOOK="$1"

BUILD_DIR="build/site/tinymce"

SOURCE_VERSION="latest"
SOURCE_DIR="$BUILD_DIR/$SOURCE_VERSION/"

DEST_VERSION=6
DEST_DIR="$BUILD_DIR/$DEST_VERSION/"

rm -rf "$BUILD_DIR"
antora "$PLAYBOOK"

echo -e "\nCopying $SOURCE_VERSION build to $DEST_VERSION directory."

mkdir "$DEST_DIR"

cp -a "$SOURCE_DIR." "$DEST_DIR"

echo "$DEST_VERSION site now in sync with $SOURCE_VERSION."
2 changes: 1 addition & 1 deletion .github/workflows/feature_6_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion antora-playbook-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ content:
start_path: ./
urls:
html_extension_style: indexify
latest_version_segment: '6'
ui:
bundle:
url: https://tiny-cloud-docs-antora-themes-staging.s3.amazonaws.com/ui-bundle.zip
Expand Down
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: tinymce
title: TinyMCE Documentation
version: 'latest'
display_version: '6'
asciidoc:
attributes:
# anchor configuration (the @ allows it to be overridden if required)
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/6.8.1-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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].

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down

0 comments on commit 568350a

Please sign in to comment.