Skip to content

Commit 870c50b

Browse files
MitchC1999MitchC1999
authored
DOC-2234: Add workflow files to test building antora 5 docs on staging (#3040)
* DOC-2234: Build workflows * DOC-2234: Add workflow files to build antora 5 docs * DOC-2234: Add playbooks * DOC-2234: Testing changed build * DOC-2234: Testing no delete upload * DOC-2234: Delete test site * DOC-2234: Testing independent site build not deleting existing site * DOC-2234: Remove test site * DOC-2234: Finalise working upload commands * DOC-2234: Testing built sites * DOC-2234: Testing built site latest * DOC-2234: Testing include and exclude params for build * DOC-2234: Testing specific include folder * DOC-2234: Testing different include param * DOC-2234: Update exclude/include aws params in staging and release workflows * DOC-2234: Use tinymce 5 for demos
1 parent bd9831b commit 870c50b

16 files changed

+239
-11
lines changed

‎.api-version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.10.4
1+
5.10.9

‎.github/workflows/feature_5_docs.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Develop > Tiny 5 Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
paths:
7+
- '**'
8+
branches:
9+
- 'feature/5**'
10+
- 'hotfix/5**'
11+
12+
jobs:
13+
build:
14+
name: Build Docs and Deploy
15+
runs-on: ubuntu-20.04
16+
17+
strategy:
18+
matrix:
19+
node-version: [14]
20+
21+
steps:
22+
- uses: actions/checkout@v1
23+
24+
- name: Use Node.js
25+
uses: actions/setup-node@v2
26+
with:
27+
cache: 'yarn'
28+
node-version: ${{ matrix.node-version }}
29+
30+
- name: (Feature - Docs 5) Install dependencies
31+
run: yarn install
32+
33+
- name: (Feature - Docs 5) Build API References
34+
run: yarn build
35+
36+
- name: (Feature - Docs 5) Build Website
37+
run: yarn antora ./antora-playbook-dev.yml
38+
39+
- name: (deploy) Prepare for branch deployments
40+
shell: bash
41+
run: |
42+
printf "User-agent: * \nDisallow: /\n" > ./build/site/robots.txt
43+
S3_BUCKET=$(node -e 'console.log(`s3://docs-${process.env.GITHUB_REF.replace("refs/heads/","").replace(/[/\s]/g, "-").replace(/[^0-9a-zA-Z-]/g, "").replace(/-$/g, "").toLowerCase()}.staging.tiny.cloud`)')
44+
printf "S3_BUCKET: ${S3_BUCKET} (${#S3_BUCKET})\n"
45+
46+
if [ ${#S3_BUCKET} -lt 3 ]
47+
then
48+
echo "WARNING! S3_BUCKET name is too short"
49+
fi
50+
51+
if [ ${#S3_BUCKET} -gt 63 ]
52+
then
53+
echo "WARNING! S3_BUCKET name is too long"
54+
fi
55+
56+
echo $S3_BUCKET > S3_BUCKET
57+
58+
- name: (deploy) Upload website to S3
59+
run: aws s3 sync --acl=public-read --delete ./build/site $(cat S3_BUCKET)/docs --exclude '*' --include 'tinymce/5/*'
60+
env:
61+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
62+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
63+
AWS_EC2_METADATA_DISABLED: true

‎.github/workflows/release_5_docs.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Release > Tiny 5 Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
paths:
7+
- '**'
8+
branches:
9+
- 'release/docs-5'
10+
11+
jobs:
12+
build:
13+
name: Build Docs and Deploy
14+
runs-on: ubuntu-20.04
15+
16+
strategy:
17+
matrix:
18+
node-version: [14]
19+
20+
steps:
21+
- uses: actions/checkout@v1
22+
23+
- name: Use Node.js
24+
uses: actions/setup-node@v2
25+
with:
26+
cache: 'yarn'
27+
node-version: ${{ matrix.node-version }}
28+
29+
- name: (Release - Docs 5) Install dependencies
30+
run: yarn install
31+
32+
- name: (Release - Docs 5) Build API References
33+
run: yarn build
34+
35+
- name: (Release - Docs 5) Build Website
36+
run: yarn antora ./antora-playbook-prod.yml
37+
38+
- name: (Release - Docs 5) Rename sitemap.xml
39+
shell: bash
40+
run: |
41+
mv ./build/site/sitemap.xml ./build/site/antora-5-sitemap.xml
42+
43+
- name: (deploy) Upload to S3
44+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude '*' --include 'tinymce/5/*'
45+
env:
46+
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
47+
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
48+
AWS_EC2_METADATA_DISABLED: true
49+
50+
- name: (deploy) Invalidate Cache
51+
run: aws cloudfront create-invalidation --distribution-id E3LFU502SQ5UR --paths "/docs/*"
52+
env:
53+
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
54+
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
55+
AWS_EC2_METADATA_DISABLED: true

‎.github/workflows/staging_5_docs.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Staging > Tiny 5 Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
paths:
7+
- '**'
8+
branches:
9+
- 'staging/docs-5'
10+
11+
jobs:
12+
build:
13+
name: Build Docs and Deploy
14+
runs-on: ubuntu-20.04
15+
16+
strategy:
17+
matrix:
18+
node-version: [14]
19+
20+
steps:
21+
- uses: actions/checkout@v1
22+
23+
- name: Use Node.js
24+
uses: actions/setup-node@v2
25+
with:
26+
cache: 'yarn'
27+
node-version: ${{ matrix.node-version }}
28+
29+
- name: (Staging - Docs 5) Install dependencies
30+
run: yarn install
31+
32+
- name: (Staging - Docs 5) Build API References
33+
run: yarn build
34+
35+
- name: (Staging - Docs 5) Build Website
36+
run: yarn antora ./antora-playbook-staging.yml
37+
38+
- name: (Staging - Docs 6) Rename sitemap.xml
39+
shell: bash
40+
run: |
41+
mv ./build/site/sitemap.xml ./build/site/antora-5-sitemap.xml
42+
43+
- name: (deploy) Upload to S3
44+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude '*' --include 'tinymce/5/*'
45+
env:
46+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
47+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
48+
AWS_EC2_METADATA_DISABLED: true
49+
50+
- name: (deploy) Invalidate Cache
51+
run: aws cloudfront create-invalidation --distribution-id E7DUUPEI08HNW --paths "/docs/*"
52+
env:
53+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
54+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
55+
AWS_EC2_METADATA_DISABLED: true

‎antora-playbook-dev.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
site:
2+
title: TinyMCE Documentation (Dev)
3+
url: https://www.tiny.cloud/docs
4+
start_page: tinymce::index.adoc
5+
content:
6+
sources:
7+
- url: ./
8+
branches: HEAD
9+
start_path: ./
10+
urls:
11+
html_extension_style: indexify
12+
ui:
13+
bundle:
14+
url: https://tiny-cloud-docs-antora-themes-staging.s3.amazonaws.com/ui-bundle.zip
15+
asciidoc:
16+
attributes:
17+
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/5/tinymce.min.js
18+
extensions:
19+
- '@tinymce/antora-extension-livedemos'

‎antora-playbook-prod.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
site:
2+
title: TinyMCE Documentation
3+
url: https://www.tiny.cloud/docs
4+
start_page: tinymce::index.adoc
5+
content:
6+
sources:
7+
- url: ./
8+
branches: HEAD
9+
start_path: ./
10+
urls:
11+
html_extension_style: indexify
12+
ui:
13+
bundle:
14+
url: https://tiny-cloud-docs-antora-themes-production.s3.amazonaws.com/ui-bundle.zip
15+
asciidoc:
16+
extensions:
17+
- '@tinymce/antora-extension-livedemos'

‎antora-playbook-staging.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
site:
2+
title: TinyMCE Documentation (Staging)
3+
url: https://staging.tiny.cloud/docs
4+
start_page: tinymce::index.adoc
5+
content:
6+
sources:
7+
- url: ./
8+
branches: HEAD
9+
start_path: ./
10+
urls:
11+
html_extension_style: indexify
12+
ui:
13+
bundle:
14+
url: https://tiny-cloud-docs-antora-themes-staging.s3.amazonaws.com/ui-bundle.zip
15+
asciidoc:
16+
attributes:
17+
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/5/tinymce.min.js
18+
extensions:
19+
- '@tinymce/antora-extension-livedemos'

‎modules/ROOT/nav.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
** xref:enterprise/tiny-comments.adoc[Commenting & collaboration]
147147
** xref:enterprise/tinydrive.adoc[Cloud-based file management]
148148
** xref:enterprise/moxiemanager.adoc[Self-hosted file management]
149-
** xref:enterprise/premium-skins-and-icon-packs.adoc[Tiny Skins and Icon Packs]
149+
** xref:enterprise/premium-skins-and-icon-packs/index.adoc[Tiny Skins and Icon Packs]
150150
*** xref:enterprise/premium-skins-and-icon-packs/bootstrap-demo.adoc[Bootstrap Demo]
151151
*** xref:enterprise/premium-skins-and-icon-packs/material-classic-demo.adoc[Material Classic Demo]
152152
*** xref:enterprise/premium-skins-and-icon-packs/material-outline-demo.adoc[Material Outline Demo]
@@ -163,16 +163,16 @@
163163
** xref:enterprise/formatpainter.adoc[Format Painter]
164164
** xref:enterprise/checklist.adoc[Checklist]
165165
** xref:enterprise/paste-from-word.adoc[Paste from Word]
166-
** xref:enterprise/check-spelling.adoc[Spell checking as-you-type]
166+
** xref:enterprise/check-spelling/index.adoc[Spell checking as-you-type]
167167
*** xref:enterprise/check-spelling/custom.adoc[Adding custom dictionaries]
168168
** xref:enterprise/casechange.adoc[Case Change]
169169
** xref:enterprise/check-links.adoc[Hyperlink checking]
170-
** xref:enterprise/embed-media.adoc[Media embedding]
170+
** xref:enterprise/embed-media/index.adoc[Media embedding]
171171
*** xref:enterprise/embed-media/mediaembed-server-config.adoc[Configure Enhanced Media Embed Server]
172172
*** xref:enterprise/embed-media/mediaembed-server-integration.adoc[Integrate Enhanced Media Embed Server]
173173
** xref:enterprise/accessibility.adoc[Accessibility checking]
174174
** xref:enterprise/mentions.adoc[Mentions]
175-
** xref:enterprise/server.adoc[Server-side component installation]
175+
** xref:enterprise/server/index.adoc[Server-side component installation]
176176
*** xref:enterprise/server/configure.adoc[Configure server-side components]
177177
*** xref:enterprise/server/self-hosting-hunspell.adoc[Using Hunspell dictionaries]
178178
*** xref:enterprise/server/dockerservices.adoc[Containerized service deployments]

‎modules/ROOT/pages/advanced/available-menu-items.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
7474

7575
:plugincategory: premium
7676
:pluginname: Comments
77-
:plugincode: comments
77+
:plugincode: tinycomments
7878
include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
7979

8080
:plugincategory: opensource

‎modules/ROOT/pages/enterprise/server/configure.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,14 +487,14 @@ To write the logs to a specific file:
487487
488488
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
489489
<encoder>
490-
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
490+
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger\{36\} - %msg%n</pattern>
491491
</encoder>
492492
</appender>
493493
494494
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
495495
<file>{$LOG_LOCATION}</file>
496496
<encoder>
497-
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
497+
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger\{36\} - %msg%n</pattern>
498498
</encoder>
499499
</appender>
500500

0 commit comments

Comments
 (0)