Skip to content

Commit 41d0f7f

Browse files
committed
Merge branch 'pgulutzan-gh-2516' of github.com:tarantool/doc into pgulutzan-gh-2516
2 parents 7f3234c + 39bfda7 commit 41d0f7f

File tree

368 files changed

+12171
-5205
lines changed

Some content is hidden

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

368 files changed

+12171
-5205
lines changed

.github/ISSUE_TEMPLATE/document.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
---
2-
name: Write or Update
2+
name: Write or update
33
about: Write or update a documentation page
4-
title: "[0pt] {feature_name}"
4+
title: "{feature_name}"
55
labels:
66
assignees:
77
---
8-
# Feature name
9-
10-
Fill in whatever you know at the moment.
8+
**Related dev. issue(s):** GitHub link(s)
119

1210
**Product:** Tarantool, Cartridge, TDG, connectors, tools?
1311
**Since:** product version
1412
**Audience/target:** who will read it and for what task?
1513
**Root document:** where to add or update documentation
1614
**SME:** @ expert to ask for more information
17-
**Peer reviewer:** @ documentarian name
1815

1916
# Details
2017

@@ -43,4 +40,4 @@ Fill in whatever you know at the moment.
4340
- [ ] Estimate complexity in storypoints in the title
4441
- [ ] Add to **Documentation** board → **Backlog**
4542

46-
> Note: issue templates are in beta. Give your feedback in #1869.
43+
> Note: issue templates are in beta. Give your feedback in #1869.

.github/ISSUE_TEMPLATE/epic.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Epic
3+
about: Create an umbrella ticket for future release documentation
4+
title: "[Epic] {epic_name}"
5+
labels: epic
6+
assignees:
7+
---
8+
**Related dev. epic:** GitHub link
9+
**PM ref.:** Notion link
10+
**SME:** @ expert to ask for more information
11+
12+
# Details
13+
14+
- [ ] GitHub issue
15+
- [ ] GitHub issue
16+
17+
Provide any details you consider necessary.

.github/ISSUE_TEMPLATE/fix.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
name: Fix & Proofread
2+
name: Fix & proofread
33
about: Fix typos, proofread document
4-
title: "[0pt] Fix {document_title}"
4+
title: "Fix {document_title}"
55
labels: typo
66
assignees:
77
---

.github/ISSUE_TEMPLATE/tech.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Technical/internal issue
3-
about: Technical debt in the docs
4-
title: "[0pt] {do X}"
3+
about: Technical issue in the docs
4+
title: "{do X}"
55
labels: internal
66
assignees:
77
---
@@ -16,11 +16,8 @@ assignees:
1616

1717
# Planning checklist
1818

19-
- [ ] Pick label:
20-
- [CI/CD](https://github.com/tarantool/doc/labels/CI/CD)
21-
- [localization](https://github.com/tarantool/doc/labels/localization)
22-
- or others.
19+
- [ ] Pick a label
2320
- [ ] Estimate complexity in storypoints in the title
2421
- [ ] Add to **Documentation** board → **Backlog**
2522

26-
> Note: issue templates are in beta. Give your feedback in #1869.
23+
> Note: issue templates are in beta. Give your feedback in #1869.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Technical debt epic
3+
about: Umbrella ticket for technical debt in the docs
4+
title: "[Tech debt] {epic_name}"
5+
labels: epic
6+
assignees:
7+
---
8+
9+
# Details
10+
11+
- [ ] GitHub issue
12+
- [ ] GitHub issue
13+
14+
Provide any details you consider necessary.

.github/ISSUE_TEMPLATE/translate.md

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

.github/ISSUE_TEMPLATE/versions.md

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

.github/workflows/deploy-branch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ jobs:
4848
token: ${{secrets.GITHUB_TOKEN}}
4949
status: ${{job.status}}
5050
deployment_id: ${{steps.deployment.outputs.deployment_id}}
51-
env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.BRANCH_NAME}}
51+
env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.BRANCH_NAME}}/

.github/workflows/main.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ jobs:
3232
- run: make build-modules
3333
- run: make json
3434
- run: make json-ru
35-
- run: make singlehtml
36-
- run: make singlehtml-ru
3735
- run: make pdf
3836
- run: make pdf-ru
3937
- uses: nelonoel/[email protected]

.github/workflows/pull-translation.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
- uses: actions/checkout@v2
2020
with:
2121
token: "${{ secrets.TARANTOOLBOT_TOKEN }}"
22-
fetch-depth: 2
22+
fetch-depth: 0
2323

2424
- name: Set branch name from source branch
2525
run: echo "BRANCH_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV
@@ -47,15 +47,20 @@ jobs:
4747
run: make cleanup-po
4848

4949
- name: Set $CHANGED_POS for changed .rst files only
50-
run: echo "CHANGED_POS=$(echo "$(git diff --name-only | grep .po | sed "s/.po//" | sed "s/locale\/ru\/LC_MESSAGES\///")" | awk -v rst="$(git diff-tree --no-commit-id --name-only -r HEAD | grep .rst | tr "\n" " ")" 'rst ~ $0{ print "locale/ru/LC_MESSAGES/"$0".po" }')" >> $GITHUB_ENV
50+
shell: bash
51+
run: |
52+
set -x
53+
. list_changed_po.sh
54+
if [ -z "${CHANGED_POS}" ]; then exit 1; fi
55+
echo "CHANGED_POS=${CHANGED_POS}" >> $GITHUB_ENV
5156
if: ${{github.event.inputs.commit_po_for_unchanged_rst == 'false'}}
5257

5358
- name: Set $CHANGED_POS for all .rst files
54-
run: echo "CHANGED_POS=.po" >> $GITHUB_ENV
59+
run: echo "CHANGED_POS=*.po" >> $GITHUB_ENV
5560
if: ${{github.event.inputs.commit_po_for_unchanged_rst != 'false'}}
5661

5762
- name: Commit translation files
58-
uses: stefanzweifel/git-auto-commit-action@v4.1.2
63+
uses: stefanzweifel/git-auto-commit-action@v4.12.0
5964
with:
6065
commit_message: "Update translations"
6166
file_pattern: "${{ env.CHANGED_POS }}"

.github/workflows/push-translation.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Push translation sources
22

33
on:
4-
pull_request:
4+
workflow_dispatch:
55
paths:
66
- 'doc/**/*.rst'
77
- 'conf.py'
@@ -14,7 +14,7 @@ jobs:
1414
- uses: actions/checkout@v2
1515

1616
- name: Set branch name from source branch
17-
run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
17+
run: echo "BRANCH_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV
1818

1919
- name: Start translation service deployment
2020
uses: bobheadxi/[email protected]

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ locale/**/*.mo
77
_*_build/
88
deploy_key
99
.venv
10+
venv
1011
output
1112
*.pyc
1213
_theme/tarantool/static/design.css.map

CMakeLists.txt

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ add_custom_target(update-pot
240240
COMMENT "Update translation sources"
241241
)
242242

243-
add_custom_target(update-po-no-force
243+
add_custom_target(update-po
244244
COMMAND "${SPHINX_INTL_EXECUTABLE}"
245245
update
246246
-p "${CMAKE_CURRENT_SOURCE_DIR}/locale/en/"
@@ -267,13 +267,6 @@ add_custom_target(cleanup-pot
267267
COMMENT "Cleanup and rearrange POT files"
268268
)
269269

270-
add_custom_target(update-po
271-
COMMAND make
272-
add-fake-msg
273-
update-po-no-force
274-
rm-fake-msg
275-
)
276-
277270
add_custom_target(linkcheck
278271
COMMAND "${SPHINX_EXECUTABLE}"
279272
-b linkcheck

0 commit comments

Comments
 (0)