Skip to content

Commit 23a6a76

Browse files
andrey-helldarandrey-helldar
authored
Merge pull request #206 from TheDragonCode/7.x
Replacing the documentation generator on Jetbrains Writerside
2 parents 7dfb04c + 83f65a4 commit 23a6a76

File tree

93 files changed

+2779
-1547
lines changed

Some content is hidden

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

93 files changed

+2779
-1547
lines changed

‎.gitattributes

-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,4 @@ tests/ export-ignore
1111
.gitattributes export-ignore
1212
.gitignore export-ignore
1313

14-
package.json export-ignore
1514
phpunit.xml export-ignore

‎.github/workflows/docs.yml

+100-29
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,124 @@
1-
name: docs
1+
name: Documentation
22

33
on:
44
push:
55
branches:
66
- main
7-
workflow_run:
8-
workflows:
9-
- changelog
10-
types:
11-
- completed
127
workflow_dispatch:
138

14-
permissions: write-all
9+
permissions:
10+
id-token: write
11+
pages: write
12+
13+
env:
14+
COMPOSER_TOKEN: ${{ secrets.COMPOSER_TOKEN }}
15+
ARTIFACT_DOCS: webHelpDO2-all.zip
16+
INSTANCE: docs/do
17+
DOMAIN_NAME: deploy-operations.dragon-code.pro
18+
BUILDER_VERSION: 2025.03.8312
1519

1620
jobs:
17-
generate:
21+
build:
22+
name: Build application
1823
runs-on: ubuntu-latest
1924

2025
steps:
2126
- uses: actions/checkout@v4
2227
with:
2328
fetch-depth: 0
24-
token: ${{ secrets.GITHUB_TOKEN }}
2529

26-
- name: Setup Node.js
27-
uses: actions/setup-node@v4
30+
- name: Build documentation
31+
uses: JetBrains/writerside-github-action@v4
2832
with:
29-
node-version: '22'
33+
instance: ${{ env.INSTANCE }}
34+
artifact: ${{ env.ARTIFACT_DOCS }}
35+
docker-version: ${{ env.BUILDER_VERSION }}
3036

31-
- name: Cache dependencies
32-
uses: actions/cache@v4
33-
id: npm-cache
37+
- name: Upload artifacts
38+
uses: actions/upload-artifact@v4
3439
with:
40+
name: docs
3541
path: |
36-
**/node_modules
37-
key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
38-
restore-keys: |
39-
${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
42+
artifacts/${{ env.ARTIFACT_DOCS }}
43+
artifacts/report.json
44+
retention-days: 7
4045

41-
- name: Install dependencies
42-
run: npm i
46+
test:
47+
needs: build
48+
name: Testing
49+
runs-on: ubuntu-latest
4350

44-
- name: Build VuePress site
45-
run: npm run build
51+
steps:
52+
- name: Download docs artifact
53+
uses: actions/download-artifact@v4
54+
with:
55+
name: docs
56+
path: artifacts
4657

47-
- name: Deploy to GitHub Pages
48-
uses: crazy-max/[email protected]
58+
- name: Test documentation
59+
uses: JetBrains/writerside-checker-action@v1
60+
with:
61+
instance: ${{ env.INSTANCE }}
62+
63+
robots:
64+
needs: build
65+
name: Generate robots.txt
66+
runs-on: ubuntu-latest
67+
68+
steps:
69+
- name: Create robots.txt
70+
run: |
71+
touch robots.txt
72+
echo "User-Agent: *" >> robots.txt
73+
echo "Disallow: " >> robots.txt
74+
echo "Host: https://${{ env.DOMAIN_NAME }}" >> robots.txt
75+
echo "Sitemap: https://${{ env.DOMAIN_NAME }}/sitemap.xml" >> robots.txt
76+
77+
- name: Upload artifacts
78+
uses: actions/upload-artifact@v4
4979
with:
50-
target_branch: gh-pages
51-
build_dir: docs/.vuepress/dist
52-
env:
53-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
80+
name: robots
81+
path: robots.txt
82+
retention-days: 7
83+
84+
deploy-pages:
85+
environment:
86+
name: deploy
87+
url: ${{ steps.deployment.outputs.page_url }}
88+
89+
needs:
90+
- test
91+
- robots
92+
93+
name: Deploy to pages
94+
runs-on: ubuntu-latest
95+
96+
steps:
97+
- name: Download docs artifact
98+
uses: actions/download-artifact@v4
99+
with:
100+
name: docs
101+
102+
- name: Download robots artifact
103+
uses: actions/download-artifact@v4
104+
with:
105+
name: robots
106+
107+
- name: Unzip artifact
108+
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT_DOCS }}' -d dir
109+
110+
- name: Move robots
111+
run: |
112+
sudo mv robots.txt dir/robots.txt
113+
114+
- name: Setup Pages
115+
uses: actions/configure-pages@v5
116+
117+
- name: Upload artifact
118+
uses: actions/upload-pages-artifact@v3
119+
with:
120+
path: dir
121+
122+
- name: Deploy to GitHub Pages
123+
id: deployment
124+
uses: actions/deploy-pages@v4

‎docs/.vuepress/.gitignore

-4
This file was deleted.

‎docs/.vuepress/config.js

-119
This file was deleted.

‎docs/.vuepress/public/CNAME

-1
This file was deleted.

‎docs/.vuepress/public/fonts/Nunito-SemiBold.woff2

-54.8 KB
Binary file not shown.

‎docs/.vuepress/styles/_fonts.scss

-9
This file was deleted.

‎docs/.vuepress/styles/index.scss

-17
This file was deleted.

‎docs/cfg/buildprofiles.xml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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>
7+
<generate-canonicals>true</generate-canonicals>
8+
<locale-code>en_US</locale-code>
9+
<header-logo>logo.svg</header-logo>
10+
<!-- <og-image> -->
11+
<!-- https://github.com/raw/Laravel-Lang/docs/main/docs/images/social-logo.png -->
12+
<!-- </og-image> -->
13+
<web-root>https://deploy-operations.dragon-code.pro</web-root>
14+
<enable-contribution>true</enable-contribution>
15+
<contribute-url>
16+
https://github.com/TheDragonCode/laravel-deploy-operations/edit/main/docs/
17+
</contribute-url>
18+
<custom-favicons>
19+
logo.svg,logo.svg,logo.svg,logo.svg
20+
</custom-favicons>
21+
<!-- <analytics-head-script-file> -->
22+
<!-- analytics.html -->
23+
<!-- </analytics-head-script-file> -->
24+
<versions-switcher>
25+
https://github.com/raw/TheDragonCode/laravel-deploy-operations/refs/heads/main/docs/versions.json
26+
</versions-switcher>
27+
</variables>
28+
<build-profile instance="do">
29+
<variables>
30+
<product-web-url>https://deploy-operations.dragon-code.pro/</product-web-url>
31+
<noindex-content>false</noindex-content>
32+
<!-- <og-image> -->
33+
<!-- https://github.com/raw/TheDragonCode/laravel-deploy-operations/main/docs/images/social-logo.png -->
34+
<!-- </og-image> -->
35+
</variables>
36+
</build-profile>
37+
<sitemap priority="0.5" change-frequency="weekly" />
38+
<footer>
39+
<social type="github" href="https://github.com/TheDragonCode">
40+
GitHub
41+
</social>
42+
<link href="https://boosty.to/dragon-code">
43+
Boosty
44+
</link>
45+
<link href="https://github.com/TheDragonCode/laravel-deploy-operations/issues">
46+
Issues
47+
</link>
48+
</footer>
49+
</buildprofiles>

0 commit comments

Comments
 (0)