Skip to content

Commit dce109b

Browse files
MitchC1999MitchC1999
authored
Merge pull request #3076 from tinymce/staging/docs-5
Bring antora 5 docs to live docs site
2 parents bd9831b + 51d0b22 commit dce109b

File tree

138 files changed

+1960
-1521
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+1960
-1521
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-22.04
16+
17+
strategy:
18+
matrix:
19+
node-version: [21]
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
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: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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-22.04
15+
16+
strategy:
17+
matrix:
18+
node-version: [21]
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: (deploy) Upload to S3
39+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-production/docs --exclude '*' --include 'tinymce/5/*'
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'
47+
env:
48+
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
49+
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
50+
AWS_EC2_METADATA_DISABLED: true
51+
52+
- name: (deploy) Invalidate Cache
53+
run: aws cloudfront create-invalidation --distribution-id E3LFU502SQ5UR --paths "/docs/*"
54+
env:
55+
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
56+
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
57+
AWS_EC2_METADATA_DISABLED: true

‎.github/workflows/staging_5_docs.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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-22.04
15+
16+
strategy:
17+
matrix:
18+
node-version: [21]
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: (deploy) Upload to S3
39+
run: aws s3 sync --acl=public-read --delete ./build/site s3://tiny-cloud-antora-docs-staging/docs --exclude '*' --include 'tinymce/5/*'
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'
47+
env:
48+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
49+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
50+
AWS_EC2_METADATA_DISABLED: true
51+
52+
- name: (deploy) Invalidate Cache
53+
run: aws cloudfront create-invalidation --distribution-id E7DUUPEI08HNW --paths "/docs/*"
54+
env:
55+
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
56+
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
57+
AWS_EC2_METADATA_DISABLED: true

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ _site/
1111

1212
# Moxiedoc files
1313
moxiedoc_nav.adoc
14-
modules/ROOT/pages/apis/
14+
modules/ROOT/pages/api/

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# TinyMCE documentation
22

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

‎_new_content_templates/blank_releasenotes.adoc‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ The following "list" should be added to `data/nav.yml`
2525

2626
== Overview
2727

28-
{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:
29-
30-
* <<newfeatures,New features>>
31-
* <<enhancements,Enhancements>>
32-
* <<functionalitychanges,Functionality changes>>
33-
* <<accompanyingpremiumpluginchanges,Accompanying Premium Plugin changes>>
34-
* <<accompanyingpremiumskinsandiconpackschanges,Accompanying Premium Skins and Icon Packs changes>>
35-
* <<accompanyingpremiumself-hostedserver-sidecomponentchanges,Accompanying Premium self-hosted server-side component changes>>
36-
* <<generalbugfixes,General bug fixes>>
37-
* <<securityfixes,Security fixes>>
38-
* <<deprecatedfeatures,Deprecated features>>
39-
* <<knownissues,Known issues>>
40-
* <<upgradingtothelatestversionoftinymce5,Upgrading to the latest version of TinyMCE 5>>
28+
{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:
29+
30+
* xref:newfeatures[New features]
31+
* xref:enhancements[Enhancements]
32+
* xref:functionalitychanges[Functionality changes]
33+
* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium Plugin changes]
34+
* xref:accompanyingpremiumskinsandiconpackschanges[Accompanying Premium Skins and Icon Packs changes]
35+
* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
36+
* xref:general-bug-fixes[General bug fixes]
37+
* xref:security-fixes[Security fixes]
38+
* xref:deprecatedfeatures[Deprecated features]
39+
* xref:knownissues[Known issues]
40+
* xref:upgrading-to-the-latest-version-of-tinymce-5[Upgrading to the latest version of TinyMCE 5]
4141

4242
include::partial$misc/releasenotes_for_stable.adoc[]
4343

@@ -77,21 +77,21 @@ The following premium plugin updates were released alongside {productname} vnumt
7777

7878
=== Premium Plugin Name X.Y.Z
7979

80-
The {productname} vnumtxt release includes an accompanying release of the *<<Premium Plugin Name>>* premium plugin.
80+
The {productname} vnumtxt release includes an accompanying release of the *Premium Plugin Name* premium plugin.
8181

82-
*<<Premium Plugin Name>>* X.Y.Z adds the following new features:
82+
*Premium Plugin Name* X.Y.Z adds the following new features:
8383

8484
* {blank}+++<Description>++++++</Description>+++
8585

86-
*<<Premium Plugin Name>>* X.Y.Z introduces the following enhancements:
86+
*Premium Plugin Name* X.Y.Z introduces the following enhancements:
8787

8888
* {blank}+++<Description>++++++</Description>+++
8989

90-
*<<Premium Plugin Name>>* X.Y.Z provides the following bug fixes:
90+
*Premium Plugin Name* X.Y.Z provides the following bug fixes:
9191

9292
* {blank}+++<Description>++++++</Description>+++
9393

94-
For information on the <<Premium Plugin Name>> plugin, see: link:{baseurl}/plugins/<<Premium Plugin Name>>/[<<Premium Plugin Name>> plugin].
94+
For information on the Premium Plugin Name plugin, see: xref:plugins/pluginname.adoc[Premium Plugin Name plugin].
9595

9696
== Accompanying Premium Skins and Icon Packs changes
9797

@@ -103,7 +103,7 @@ The {productname} vnumtxt release includes an accompanying release of the *Premi
103103
Add description here.
104104
////
105105

106-
For information on using premium skins and icon packs, see: link:{baseurl}/enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
106+
For information on using premium skins and icon packs, see: xref:enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
107107

108108
=== Premium Skins and Icon Packs - Bug fixes
109109

@@ -113,9 +113,9 @@ The *Premium Skins and Icon Packs* release includes the following bug fixes:
113113
Add description here.
114114
////
115115

116-
For information on using premium skins and icon packs, see: link:{baseurl}/enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
116+
For information on using premium skins and icon packs, see: xref:enterprise/premium-skins-and-icon-packs/[Premium Skins and Icon Packs].
117117

118-
[[accompanyingpremiumself-hostedserver-sidecomponentchanges]]
118+
[[accompanying-premium-self-hosted-server-side-component-changes]]
119119
== Accompanying Premium self-hosted server-side component changes
120120

121121
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:
132132
* `ephox-hyperlinking.war`: X.Y.Z
133133
* `ephox-image-proxy.war`: X.Y.Z
134134

135-
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].
135+
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].
136136

137137
For information on:
138138

139-
* The Spell Checker Pro plugin, see: link:{baseurl}/plugins/premium/tinymcespellchecker/[Spell Checker Pro plugin].
140-
* The Link Checker plugin, see: link:{baseurl}/plugins/premium/linkchecker/[Link Checker plugin].
141-
* The Image Tools plugin, see: link:{baseurl}/plugins/opensource/imagetools/[Image Tools plugin].
142-
* The Enhanced Media Embed plugin, see: link:{baseurl}/plugins/premium/mediaembed/[Enhanced Media Embed plugin].
143-
* Deploying the server-side components, see: link:{baseurl}/enterprise/server/[Server-side component installation].
139+
* The Spell Checker Pro plugin, see: xref:plugins/premium/tinymcespellchecker/[Spell Checker Pro plugin].
140+
* The Link Checker plugin, see: xref:plugins/premium/linkchecker/[Link Checker plugin].
141+
* The Image Tools plugin, see: xref:plugins/opensource/imagetools/[Image Tools plugin].
142+
* The Enhanced Media Embed plugin, see: xref:plugins/premium/mediaembed/[Enhanced Media Embed plugin].
143+
* Deploying the server-side components, see: xref:enterprise/server/[Server-side component installation].
144144

145145
=== Updating the self-hosted server-side components
146146

@@ -157,8 +157,8 @@ The new versions of the server-side services provide updates for the Java-based
157157

158158
For information on:
159159

160-
* Deploying the server-side components, see: link:{baseurl}/enterprise/server/[Server-side component installation].
161-
* Deploying the server-side components using Docker, see: link:{baseurl}/enterprise/server/dockerservices/[Containerized service deployments].
160+
* Deploying the server-side components, see: xref:enterprise/server/[Server-side component installation].
161+
* Deploying the server-side components using Docker, see: xref:enterprise/server/dockerservices/[Containerized service deployments].
162162

163163
== General bug fixes
164164

@@ -176,17 +176,17 @@ For information on:
176176

177177
The following features have been deprecated with the release of {productname} vnumtxt:
178178

179-
* <<,>>.
179+
* xref:placeholder[placeholder].
180180

181181
=== The...
182182

183183
== Known issues
184184

185185
This section describes issues that users of {productname} vnumtxt may encounter and possible workarounds for these issues.
186186

187-
* <<,>>
187+
* xref:placeholder[placeholder].
188188

189-
=== ,
189+
=== placeholder
190190

191191
Issue:: This issue affects ....
192192

‎_scripts/api-reference-local.sh‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ echo -e "\n > importing data files for tinymce api reference: local from $1\n"
1414

1515
rm -rf "$API_TMPDIR"
1616
mkdir "$API_TMPDIR"
17-
npx moxiedoc "$1/modules/tinymce/src/core/main/ts" -t antora -o "$API_TMPDIR/tinymce-api-reference.zip"
17+
npx moxiedoc "$1/modules/tinymce/src/core/main/ts" -t antora -s "legacy" -o "$API_TMPDIR/tinymce-api-reference.zip"
1818
unzip -o "$API_TMPDIR/tinymce-api-reference.zip"
1919

2020
# remove old api adoc pages
21-
rm -rf modules/ROOT/pages/apis/
21+
rm -rf modules/ROOT/pages/api/
2222

2323
# removed old static api html pages (clear cache), it can corrupt the build
24-
rm -rf build/site/_/tinymce/6.0/apis/
24+
rm -rf build/site/tinymce/5/api/
2525

2626
# move newly generated adoc pages, antora will then generate new static html pages
27-
mv _data/antora modules/ROOT/pages/apis
27+
mv _data/antora/api modules/ROOT/pages
2828

2929
# move api navigation
3030
mv _data/moxiedoc_nav.adoc modules/ROOT/moxiedoc_nav.adoc

‎_scripts/api-reference.sh‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ rm -rf _data
1313
rm -rf "$API_TMPDIR"
1414
mkdir "$API_TMPDIR"
1515
curl -s "$TARBALL_URL" | tar xzf - -C "$API_TMPDIR" --strip-components 1
16-
npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -o "$API_TMPDIR/tinymce-api-reference.zip"
16+
npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -s "legacy" -o "$API_TMPDIR/tinymce-api-reference.zip"
1717
unzip -o "$API_TMPDIR/tinymce-api-reference.zip"
1818

1919
# remove old api adoc pages
20-
rm -rf modules/ROOT/pages/apis/
20+
rm -rf modules/ROOT/pages/api/
2121

2222
# removed old static api html pages (clear cache), it can corrupt the build
23-
rm -rf build/site/_/tinymce/6.0/apis/
23+
rm -rf build/site/tinymce/5/api/
2424

2525
# move newly generated adoc pages, antora will then generate new static html pages
26-
mv _data/antora modules/ROOT/pages/apis
26+
mv _data/antora/api modules/ROOT/pages/
2727

2828
# move api navigation
2929
mv _data/moxiedoc_nav.adoc modules/ROOT/moxiedoc_nav.adoc

0 commit comments

Comments
 (0)