Skip to content

Commit 11154ec

Browse files
authored
DOC-2264: Update 6 docs workflows to prepare for 7 (#3054)
* 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
1 parent e55f0ea commit 11154ec

File tree

8 files changed

+32
-57
lines changed

8 files changed

+32
-57
lines changed

-scripts/generate-site.sh

Lines changed: 0 additions & 25 deletions
This file was deleted.

.github/workflows/feature_6_docs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ on:
1212
jobs:
1313
build:
1414
name: Build Docs and Deploy
15-
runs-on: ubuntu-20.04
15+
runs-on: ubuntu-22.04
1616

1717
strategy:
1818
matrix:
19-
node-version: [14]
19+
node-version: [21]
2020

2121
steps:
2222
- uses: actions/checkout@v1
@@ -34,7 +34,7 @@ jobs:
3434
run: yarn build
3535

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

3939
- name: (deploy) Prepare for branch deployments
4040
shell: bash
@@ -56,7 +56,7 @@ jobs:
5656
echo $S3_BUCKET > S3_BUCKET
5757
5858
- name: (deploy) Upload website to S3
59-
run: aws s3 sync --acl=public-read --delete ./build/site $(cat S3_BUCKET)/docs --exclude 'tinymce/*' --include 'tinymce/latest/*' --include 'tinymce/6/*'
59+
run: aws s3 sync --acl=public-read --delete ./build/site $(cat S3_BUCKET)/docs
6060
env:
6161
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
6262
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}

.github/workflows/release_6_docs.yml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ on:
1111
jobs:
1212
build:
1313
name: Build Docs and Deploy
14-
runs-on: ubuntu-20.04
14+
runs-on: ubuntu-22.04
1515

1616
strategy:
1717
matrix:
18-
node-version: [14]
18+
node-version: [21]
1919

2020
steps:
2121
- uses: actions/checkout@v1
@@ -33,15 +33,17 @@ jobs:
3333
run: yarn build
3434

3535
- name: (Release - Docs 6) Build Website
36-
run: yarn generate-site ./antora-playbook-prod.yml
37-
38-
- name: (Release - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
39-
shell: bash
40-
run: |
41-
mv ./build/site/sitemap.xml ./build/site/antora-sitemap.xml
36+
run: yarn antora ./antora-playbook-prod.yml
4237

4338
- name: (deploy) Upload site to S3
44-
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/*'
39+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude '*' --include 'tinymce/6/*'
40+
env:
41+
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
42+
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
43+
AWS_EC2_METADATA_DISABLED: true
44+
45+
- name: (deploy) Upload images to S3
46+
run: aws s3 sync --acl=public-read ./build/site/_ s3://tiny-cloud-antora-docs-production/docs/_ --exclude '*' --include 'img'
4547
env:
4648
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
4749
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}

.github/workflows/staging_6_docs.yml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ on:
1111
jobs:
1212
build:
1313
name: Build Docs and Deploy
14-
runs-on: ubuntu-20.04
14+
runs-on: ubuntu-22.04
1515

1616
strategy:
1717
matrix:
18-
node-version: [14]
18+
node-version: [21]
1919

2020
steps:
2121
- uses: actions/checkout@v1
@@ -33,15 +33,17 @@ jobs:
3333
run: yarn build
3434

3535
- name: (Staging - Docs 6) Build Website
36-
run: yarn generate-site ./antora-playbook-staging.yml
37-
38-
- name: (Staging - Docs 6) Rename sitemap.xml (Temporary solution - Amit)
39-
shell: bash
40-
run: |
41-
mv ./build/site/sitemap.xml ./build/site/antora-sitemap.xml
36+
run: yarn antora ./antora-playbook-staging.yml
4237

4338
- name: (deploy) Upload site to S3
44-
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/*'
39+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude '*' --include 'tinymce/6/*'
40+
env:
41+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
42+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
43+
AWS_EC2_METADATA_DISABLED: true
44+
45+
- name: (deploy) Upload images to S3
46+
run: aws s3 sync --acl=public-read ./build/site/_ s3://tiny-cloud-antora-docs-staging/docs/_ --exclude '*' --include 'img'
4547
env:
4648
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
4749
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}

antora.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: tinymce
22
title: TinyMCE Documentation
3-
version: 'latest'
4-
display_version: '6'
3+
version: '6'
54
asciidoc:
65
attributes:
76
# anchor configuration (the @ allows it to be overridden if required)

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1074,15 +1074,13 @@ In {productname} 6.4.1, this issue has been resolved.
10741074

10751075
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.
10761076

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

10801081
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.
10811082

1082-
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.
1083-
1084-
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.
1085-
1083+
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.
10861084

10871085
[[known-issues]]
10881086
== Known issues

modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ tinymce.init({
1616
});
1717
----
1818

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

2121
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`.
2222

23-
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].
23+
This prevents an xref:6.4.1-release-notes.adoc#infinite-resize[infinite resizing bug from presenting].
2424

2525
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.
2626

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
"scripts": {
1111
"build": "./-scripts/api-reference.sh",
1212
"build-local-ref": "./-scripts/api-reference-local.sh",
13-
"generate-site": "./-scripts/generate-site.sh",
14-
"nodemon-dev": "nodemon --exec yarn generate-site ./antora-playbook-dev.yml",
13+
"nodemon-dev": "nodemon --exec yarn antora ./antora-playbook-dev.yml",
1514
"server": "http-server build/site/ --port 4000",
1615
"serve": "npm-run-all -p nodemon-dev server"
1716
},

0 commit comments

Comments
 (0)