Skip to content

Commit

Permalink
DOC-2264: Update 6 docs workflows to prepare for 7 (#3054)
Browse files Browse the repository at this point in the history
* DOC-2264: Update 6 docs workflows to prepare for 7

* DOC-2264: Update site title

* DOC-2264: Sync images in workflows

* DOC-2264: Remove unnecessary sitemap rename

* DOC-2264: Fix generation
  • Loading branch information
MitchC1999 authored Feb 7, 2024
1 parent e55f0ea commit 11154ec
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 57 deletions.
25 changes: 0 additions & 25 deletions -scripts/generate-site.sh

This file was deleted.

8 changes: 4 additions & 4 deletions .github/workflows/feature_6_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -34,7 +34,7 @@ jobs:
run: yarn build

- name: (Feature - Docs 6) Build Website
run: yarn generate-site ./antora-playbook-dev.yml
run: yarn antora ./antora-playbook-dev.yml

- name: (deploy) Prepare for branch deployments
shell: bash
Expand All @@ -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 'tinymce/*' --include 'tinymce/latest/*' --include 'tinymce/6/*'
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 }}
Expand Down
20 changes: 11 additions & 9 deletions .github/workflows/release_6_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,15 +33,17 @@ jobs:
run: yarn build

- name: (Release - Docs 6) Build Website
run: yarn generate-site ./antora-playbook-prod.yml

- name: (Release - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
shell: bash
run: |
mv ./build/site/sitemap.xml ./build/site/antora-sitemap.xml
run: yarn antora ./antora-playbook-prod.yml

- name: (deploy) Upload site to S3
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude 'tinymce/*' --include 'tinymce/latest/*' --include 'tinymce/6/*'
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude '*' --include 'tinymce/6/*'
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 }}
Expand Down
20 changes: 11 additions & 9 deletions .github/workflows/staging_6_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,15 +33,17 @@ jobs:
run: yarn build

- name: (Staging - Docs 6) Build Website
run: yarn generate-site ./antora-playbook-staging.yml

- name: (Staging - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
shell: bash
run: |
mv ./build/site/sitemap.xml ./build/site/antora-sitemap.xml
run: yarn antora ./antora-playbook-staging.yml

- name: (deploy) Upload site to S3
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude 'tinymce/*' --include 'tinymce/latest/*' --include 'tinymce/6/*'
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude '*' --include 'tinymce/6/*'
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 }}
Expand Down
3 changes: 1 addition & 2 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: tinymce
title: TinyMCE Documentation
version: 'latest'
display_version: '6'
version: '6'
asciidoc:
attributes:
# anchor configuration (the @ allows it to be overridden if required)
Expand Down
6 changes: 2 additions & 4 deletions modules/ROOT/pages/6.4.1-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1074,15 +1074,13 @@ In {productname} 6.4.1, this issue has been resolved.

In previous versions of {productname}, when the editor is within a scrollable container, the toolbar would remain visible when the editor is scrolled out of view.

[[infinite-resize]]
=== Editor increases the height indefinitely when using autoresize with `content_css: 'document'`
//#TINY-8872

In previous versions of {productname}, it was discovered that the editor had some issues with the autoresize plugin when using `content_css: 'document'`, which caused the editor height to expand indefinitely.

To fix this issue, {productname} addressed the conflict between the document skin's CSS and the autoresize bottom margin setting. After this fix, the resize function now checks for loops and considers the margin bottom as always set to 0 instead of autoresize bottom margin, which ensutes that the editor's height is calculated correctly.

In {productname} 6.4.1, the default number of columns, 5, are now used when any of these options is set to 0 or less, preventing this issue from occurring.

To fix this issue, {productname} addressed the conflict between the document skin's CSS and the autoresize bottom margin setting. After this fix, the resize function now checks for loops and considers the margin bottom as always set to 0 instead of autoresize bottom margin, which ensutes that the editor's height is calculated correctly.

[[known-issues]]
== Known issues
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ tinymce.init({
});
----

As of version 6.3, {productname} checks for the {productname} resize function entering a loop.
As of version 6.4.1, {productname} checks for the {productname} resize function entering a loop.

If the function is detected as doing so, the document’s `+margin-bottom+` value is set to 0, instead of whatever value is assigned to `autoresize_bottom_margin`.

This prevents an xref:6.3-release-notes.adoc#the-autoresize-plugin-caused-the-editor-area-to-infinitely-resize-when-content_css-was-set-to-document[infinite resizing bug from presenting].
This prevents an xref:6.4.1-release-notes.adoc#infinite-resize[infinite resizing bug from presenting].

To prevent the resize function from even entering this loop, `+autoresize_bottom_margin+` must be set to a value less than any `+margin-bottom+` value set for the document.

Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
"scripts": {
"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",
"nodemon-dev": "nodemon --exec yarn antora ./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 11154ec

Please sign in to comment.