Skip to content

Improve the Release Notes section #2734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
Tracked by #2051
xuniq opened this issue Mar 3, 2022 · 0 comments · Fixed by #2743
Closed
Tracked by #2051

Improve the Release Notes section #2734

xuniq opened this issue Mar 3, 2022 · 0 comments · Fixed by #2743
Assignees
@patiencedaur
Labels
design [nature] Design issue release-notes Writing and editing release notes

Comments

@xuniq
Copy link
Contributor

xuniq commented Mar 3, 2022

Add separate page with the table of contents in the Release Notes section.

Example:
https://www.tarantool.io/en/doc/latest/reference/

Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/release/
@xuniq xuniq added rewrite [nature] Revise existing text for structure/phrasing/terms release-notes Writing and editing release notes labels Mar 3, 2022
@xuniq xuniq changed the title [0pt] Improve the Release Notes section Improve the Release Notes section Mar 3, 2022
@xuniq xuniq mentioned this issue Mar 3, 2022
Closed
22 tasks
@patiencedaur patiencedaur added design [nature] Design issue and removed rewrite [nature] Revise existing text for structure/phrasing/terms labels Mar 4, 2022
@patiencedaur patiencedaur self-assigned this Mar 10, 2022
@patiencedaur patiencedaur mentioned this issue Mar 10, 2022
Merged
patiencedaur added a commit that referenced this issue Mar 16, 2022
@patiencedaur
Redefine structure for release notes section (#2743)
4a99c28 
Resolves #2734

* Redefine structure for release notes section
* Change headers to sentence case
* Add missing release links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@patiencedaur patiencedaur

Labels
design [nature] Design issue release-notes Writing and editing release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Redefine structure for release notes section tarantool/doc
2 participants
@patiencedaur @xuniq