Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Write or Update
about: Write or update a documentation page
title: "[0pt] {feature_name}"
labels:
assignees:
---
# Feature name

Fill in whatever you know at the moment.

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

# Details

* What should we write about?
* What's most important?
* Examples of code and configuration.
* Related development issues and/or commits.

# DoD

- [ ] do A
- [ ] do B

# Planning checklist

- [ ] Pick product label:
- [server](https://github.com/tarantool/doc/labels/server) for Tarantool core
- [cartridge](https://github.com/tarantool/doc/labels/cartridge),
- [tdg](https://github.com/tarantool/doc/labels/tdg), or
- [ecosystem](https://github.com/tarantool/doc/labels/ecosystem)
for tools and connectors.
- [ ] Pick type label:
- [reference](https://github.com/tarantool/doc/labels/reference),
- [getting started](https://github.com/tarantool/doc/labels/getting%20started),
- [user_guide](https://github.com/tarantool/doc/labels/user_guide), etc.
- [ ] Estimate complexity in storypoints in the title
- [ ] Add to **Documentation** board → **Backlog**

> Note: issue templates are in beta. Give your feedback in #1869.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Fix & Proofread
about: Fix typos, proofread document
title: "[0pt] Fix {document_title}"
labels: typo
assignees:
---

## Info

**Root document:** where to fix the docs

## What's wrong?

Please give details or examples.

## Planning checklist

- [ ] Estimate complexity in storypoints in the title.
- [ ] Add to **Documentation** board → **Backlog (small)**

> Note: issue templates are in beta. Give your feedback in #1869.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/tech.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Technical/internal issue
about: Technical debt in the docs
title: "[0pt] {do X}"
labels: internal
assignees:
---
# What needs to be done

**Reviewer:** @ documentarian name

# DoD

- [ ] do A
- [ ] do B

# Planning checklist

- [ ] Pick label:
- [CI/CD](https://github.com/tarantool/doc/labels/CI/CD)
- [localization](https://github.com/tarantool/doc/labels/localization)
- or others.
- [ ] Estimate complexity in storypoints in the title
- [ ] Add to **Documentation** board → **Backlog**

> Note: issue templates are in beta. Give your feedback in #1869.
21 changes: 13 additions & 8 deletions .github/ISSUE_TEMPLATE/translate.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
---
name: Translate
about: Translation issue
title: "[0sp] Translate"
title: "[0pt] Translate {document_title}"
labels: localization
assignees: ladyune

---
## Info

Page: link to website
Crowdin: link to file in Crowdin
Words: amount of words to translate, see in Crowdin
Reviewer: author of the document or subject matter expert
**Page:** link to website
**Crowdin:** link to file in Crowdin
**Words:** amount of words to translate, see in Crowdin
**Reviewer:** author of the document or subject matter expert

- [ ] Add to Localization board → Ready for review
- [ ] Evaluate *review* in storypoints in the title
- [ ] Add to Docs board → Backlog, so that we can plan it
## Issue planning checklist

- [ ] Estimate *review* in storypoints in the title
- [ ] Add to **Localization** board → **Ready for review**
- [ ] Add to **Documentation** board → **Backlog**

> Note: issue templates are in beta. Give your feedback in #1869.