Skip to content

Commit 08ba5db

Browse files
andrey-helldarandrey-helldar
authored
Initial commit
0 parents  commit 08ba5db

26 files changed

+688
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Bug Report
2+
description: Report a bug or other issue
3+
4+
title: "[Bug]: "
5+
6+
labels:
7+
- bug
8+
9+
body:
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Issue description
14+
description: |
15+
Be as specific and detailed as possible to help us triaging your issue. Screenshots and/or animations can be very useful in helping to understand the issue you're facing.
16+
17+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
18+
Tip: You can use https://www.screentogif.com to record animations and videos.
19+
validations:
20+
required: true
21+
22+
- type: markdown
23+
attributes:
24+
value: |
25+
❤️ The Dragon Code? Please consider supporting our collective on [Boosty](https://boosty.to/dragon-code).

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Laravel issue
4+
url: https://github.com/laravel/framework/issues
5+
about: 'If you have a question about your Laravel implementation, ask it in your Laravel project.'

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Feature Proposal
2+
description: Propose a new feature
3+
4+
labels:
5+
- feature
6+
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Feature description
12+
description: |
13+
Think through your proposal and describe it clearly.
14+
15+
Note that features are only added to the most recent version of Laravel Lang Publisher.
16+
validations:
17+
required: true
18+
19+
- type: markdown
20+
attributes:
21+
value: |
22+
❤️ The Dragon Code? Please consider supporting our collective on [Boosty](https://boosty.to/dragon-code).

‎.github/dependabot.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: daily
7+
labels:
8+
- dependabot

‎.github/workflows/deploy.yml‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
repository_dispatch:
9+
types:
10+
- docs
11+
12+
permissions:
13+
id-token: write
14+
pages: write
15+
16+
env:
17+
COMPOSER_TOKEN: ${{ secrets.COMPOSER_TOKEN }}
18+
ALGOLIA_APP_NAME: ${{ secrets.ALGOLIA_APPLICATION_ID }}
19+
ALGOLIA_ARTIFACT: algolia-indexes-WRITERSIDE-DOCUMENTATION.zip
20+
ALGOLIA_INDEX_NAME: writerside-documentation
21+
ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
22+
ARTIFACT_DOCS: webHelpWRITERSIDE-DOCUMENTATION2-all.zip
23+
ARTIFACT_INDEXES: search-indexes
24+
ARTIFACT_INDEXES_CLEARED: search-indexes-cleared
25+
CONFIG_JSON_PRODUCT: WRITERSIDE-DOCUMENTATION
26+
CONFIG_JSON_VERSION: main
27+
INSTANCE: docs/writerside-documentation
28+
DOMAIN_NAME: package-wizard.com
29+
BUILDER_VERSION: 2025.03.8312
30+
31+
jobs:
32+
build:
33+
name: Build application
34+
runs-on: ubuntu-latest
35+
36+
steps:
37+
- uses: actions/checkout@v4
38+
with:
39+
fetch-depth: 0
40+
41+
- name: Setup PHP
42+
uses: shivammathur/setup-php@v2
43+
with:
44+
extensions: curl, mbstring, zip, pcntl, pdo, pdo_sqlite, iconv, simplexml
45+
coverage: xdebug
46+
47+
- name: Configure git
48+
run: git config --global --add safe.directory /github/workspace
49+
50+
- name: Build documentation
51+
uses: JetBrains/writerside-github-action@v4
52+
with:
53+
instance: ${{ env.INSTANCE }}
54+
artifact: ${{ env.ARTIFACT_DOCS }}
55+
docker-version: ${{ env.BUILDER_VERSION }}
56+
57+
- name: Upload artifacts
58+
uses: actions/upload-artifact@v4
59+
with:
60+
name: docs
61+
path: |
62+
artifacts/${{ env.ARTIFACT_DOCS }}
63+
artifacts/report.json
64+
retention-days: 7
65+
66+
- name: Upload search indexes
67+
uses: actions/upload-artifact@v4
68+
with:
69+
name: ${{ env.ARTIFACT_INDEXES }}
70+
path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
71+
retention-days: 7
72+
73+
test:
74+
needs: build
75+
name: Testing
76+
runs-on: ubuntu-latest
77+
78+
steps:
79+
- name: Download docs artifact
80+
uses: actions/download-artifact@v4
81+
with:
82+
name: docs
83+
path: artifacts
84+
85+
- name: Test documentation
86+
uses: JetBrains/writerside-checker-action@v1
87+
with:
88+
instance: ${{ env.INSTANCE }}
89+
90+
robots:
91+
needs: build
92+
name: Generate robots.txt
93+
runs-on: ubuntu-latest
94+
95+
steps:
96+
- name: Create robots.txt
97+
run: |
98+
touch robots.txt
99+
echo "User-Agent: *" >> robots.txt
100+
echo "Disallow: " >> robots.txt
101+
echo "Host: https://${{ env.DOMAIN_NAME }}" >> robots.txt
102+
echo "Sitemap: https://${{ env.DOMAIN_NAME }}/sitemap.xml" >> robots.txt
103+
104+
- name: Upload artifacts
105+
uses: actions/upload-artifact@v4
106+
with:
107+
name: robots
108+
path: robots.txt
109+
retention-days: 7
110+
111+
deploy-pages:
112+
environment:
113+
name: deploy
114+
url: ${{ steps.deployment.outputs.page_url }}
115+
116+
needs:
117+
- test
118+
- robots
119+
120+
name: Deploy to pages
121+
runs-on: ubuntu-latest
122+
123+
steps:
124+
- name: Download docs artifact
125+
uses: actions/download-artifact@v4
126+
with:
127+
name: docs
128+
129+
- name: Download robots artifact
130+
uses: actions/download-artifact@v4
131+
with:
132+
name: robots
133+
134+
- name: Unzip artifact
135+
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT_DOCS }}' -d dir
136+
137+
- name: Move robots
138+
run: |
139+
sudo mv robots.txt dir/robots.txt
140+
141+
- name: Setup Pages
142+
uses: actions/configure-pages@v5
143+
144+
- name: Upload artifact
145+
uses: actions/upload-pages-artifact@v3
146+
with:
147+
path: dir
148+
149+
- name: Deploy to GitHub Pages
150+
id: deployment
151+
uses: actions/deploy-pages@v4
152+
153+
deploy-indexes:
154+
environment: deploy
155+
156+
needs:
157+
- test
158+
159+
name: Deploy to Algolia
160+
runs-on: ubuntu-latest
161+
timeout-minutes: 3
162+
163+
container:
164+
image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
165+
166+
steps:
167+
- name: Download search artifact
168+
uses: actions/download-artifact@v4
169+
with:
170+
name: ${{ env.ARTIFACT_INDEXES_CLEARED }}
171+
172+
- name: Unzip artifact
173+
run: unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d ${{ env.ARTIFACT_INDEXES }}
174+
175+
- name: Deploy to Algolia
176+
run: |
177+
env algolia-key='${{ env.ALGOLIA_KEY }}' java -jar /opt/builder/help-publication-agent.jar \
178+
update-index \
179+
--application-name '${{ env.ALGOLIA_APP_NAME }}' \
180+
--index-name '${{ env.ALGOLIA_INDEX_NAME }}' \
181+
--product '${{ env.CONFIG_JSON_PRODUCT }}' \
182+
--version '${{ env.CONFIG_JSON_VERSION }}' \
183+
--index-directory ${{ env.ARTIFACT_INDEXES }}/ \
184+
2>&1 | tee algolia-update-index-log.txt

‎.github/workflows/tests.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
permissions: read-all
8+
9+
env:
10+
COMPOSER_TOKEN: ${{ secrets.COMPOSER_TOKEN }}
11+
INSTANCE: docs/writerside-documentation
12+
ARTIFACT_DOCS: webHelpWRITERSIDE-DOCUMENTATION2-all.zip
13+
BUILDER_VERSION: 2025.03.8312
14+
15+
jobs:
16+
build:
17+
name: Build application
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
25+
- name: Setup PHP
26+
uses: shivammathur/setup-php@v2
27+
with:
28+
extensions: curl, mbstring, zip, pcntl, pdo, pdo_sqlite, iconv, simplexml
29+
coverage: xdebug
30+
31+
- name: Configure git
32+
run: git config --global --add safe.directory /github/workspace
33+
34+
- name: Build documentation
35+
uses: JetBrains/writerside-github-action@v4
36+
with:
37+
instance: ${{ env.INSTANCE }}
38+
artifact: ${{ env.ARTIFACT_DOCS }}
39+
docker-version: ${{ env.BUILDER_VERSION }}
40+
41+
- name: Upload artifacts
42+
uses: actions/upload-artifact@v4
43+
with:
44+
name: docs
45+
path: |
46+
artifacts/${{ env.ARTIFACT_DOCS }}
47+
artifacts/report.json
48+
retention-days: 7
49+
50+
test:
51+
needs: build
52+
name: Testing
53+
runs-on: ubuntu-latest
54+
55+
steps:
56+
- name: Download docs artifact
57+
uses: actions/download-artifact@v4
58+
with:
59+
name: docs
60+
path: artifacts
61+
62+
- name: Test documentation
63+
uses: JetBrains/writerside-checker-action@v1
64+
with:
65+
instance: ${{ env.INSTANCE }}

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.idea/
2+
build/
3+
4+
.DS_Store
5+
.env
6+
.temp
7+
8+
*.bak
9+
*.cache
10+
*.clover
11+
*.orig
12+
13+
*.BASE
14+
*.LOCAL
15+
*.REMOTE
16+
17+
sitemap.xml
18+
19+
*.zip
20+
*.tar.gz

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Package Wizard, Andrey Helldar
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Writerside Documentation Template
2+
3+
![preview](https://preview.dragon-code.pro/The%20Dragon%20Code/JetBrains%20Writerside.svg?pretty-title=0&mode=light)
4+
5+
## Documentation
6+
7+
See the [documentation](https://package-wizard.com) for detailed installation instructions.
8+
9+
## Contributing
10+
11+
Please see [CONTRIBUTING](https://package-wizard.com/contributions.html) for details.
12+
13+
## Support Us
14+
15+
❤️ The Dragon Code? Please consider supporting our collective on [Boosty](https://boosty.to/dragon-code).
16+
17+
## License
18+
19+
This package is licensed under the [MIT License](https://package-wizard.com/license.html).

‎docs/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>

0 commit comments

Comments
 (0)