Skip to content

Commit 114a3c4

Browse files
committed
switched to writerside
1 parent ec5e681 commit 114a3c4

File tree

83 files changed

+371
-1426
lines changed

Some content is hidden

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

83 files changed

+371
-1426
lines changed

.etc/linksAndAcknowledgements.md

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

.github/workflows/build.yml

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Build documentation
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
id-token: write
11+
pages: write
12+
13+
env:
14+
INSTANCE: 'Writerside/v'
15+
DOCKER_VERSION: '243.22562'
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
outputs:
21+
algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
22+
artifact: ${{ steps.define-ids.outputs.artifact }}
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Define instance id and artifacts
30+
id: define-ids
31+
run: |
32+
INSTANCE=${INSTANCE#*/}
33+
INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
34+
ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
35+
ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
36+
37+
# Print the values
38+
echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
39+
echo "ARTIFACT: $ARTIFACT"
40+
echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
41+
42+
# Set the environment variables and outputs
43+
echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
44+
echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
45+
echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
46+
echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
47+
echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
48+
49+
- name: Build docs using Writerside Docker builder
50+
uses: JetBrains/writerside-github-action@v4
51+
with:
52+
instance: ${{ env.INSTANCE }}
53+
docker-version: ${{ env.DOCKER_VERSION }}
54+
55+
- name: Save artifact with build results
56+
uses: actions/upload-artifact@v4
57+
with:
58+
name: docs
59+
path: |
60+
artifacts/${{ steps.define-ids.outputs.artifact }}
61+
artifacts/report.json
62+
artifacts/${{ steps.define-ids.outputs.algolia_artifact }}
63+
retention-days: 7
64+
test:
65+
needs: build
66+
runs-on: ubuntu-latest
67+
steps:
68+
- name: Download artifacts
69+
uses: actions/download-artifact@v4
70+
with:
71+
name: docs
72+
path: artifacts
73+
74+
- name: Test documentation
75+
uses: JetBrains/writerside-checker-action@v1
76+
with:
77+
instance: ${{ env.INSTANCE }}
78+
deploy:
79+
environment:
80+
name: github-pages
81+
url: ${{ steps.deployment.outputs.page_url }}
82+
needs: [build, test]
83+
runs-on: ubuntu-latest
84+
steps:
85+
- name: Download artifacts
86+
uses: actions/download-artifact@v4
87+
with:
88+
name: docs
89+
path: artifacts
90+
91+
- name: Unzip artifact
92+
run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
93+
94+
- name: Setup Pages
95+
uses: actions/configure-pages@v4
96+
97+
- name: Package and upload Pages artifact
98+
uses: actions/upload-pages-artifact@v3
99+
with:
100+
path: dir
101+
102+
- name: Deploy to GitHub Pages
103+
id: deployment
104+
uses: actions/deploy-pages@v4

.idea/WHS-FTC-Code_Training_Module.iml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

SUMMARY.md

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

Writerside/c.list

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE categories
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
4+
<categories>
5+
<category id="wrs" name="Writerside documentation" order="1"/>
6+
</categories>

Writerside/cfg/buildprofiles.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
3+
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5+
6+
<variables></variables>
7+
<build-profile instance="v">
8+
<variables>
9+
<noindex-content>true</noindex-content>
10+
</variables>
11+
</build-profile>
12+
13+
</buildprofiles>

0 commit comments

Comments
 (0)