Skip to content

Redefine structure for release notes section #2743

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.

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

Merged
merged 8 commits into from
Mar 16, 2022

Conversation

patiencedaur
Copy link
Contributor

Resolves #2734

@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 10, 2022 09:14 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 10, 2022 09:28 Inactive
@patiencedaur patiencedaur requested review from veod32, art-dr and xuniq March 10, 2022 09:35
@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 10, 2022 13:25 Inactive
Copy link
Contributor

@xuniq xuniq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@art-dr
Copy link
Contributor

art-dr commented Mar 14, 2022

I would say the structure is good.

The only thing that bothers me is that in this menu you can see the "Summary" chapter somewhere between other chapters listed. Yet when you open the first link, which is "Release policies", the very first heading is also "Summary", but it's another summary of another chapter. It got me a bit confused.

@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 15, 2022 07:31 Inactive
@veod32
Copy link
Collaborator

veod32 commented Mar 15, 2022

The new structure is good!
A few comments:

The only thing that bothers me is that in this menu you can see the "Summary" chapter somewhere between other chapters listed. Yet when you open the first link, which is "Release policies", the very first heading is also "Summary", but it's another summary of another chapter. It got me a bit confused.

  1. Agree with @arctic-dreamer 's comment above. I would remove the Summary title on this page and the corresponding ToC item here.

  2. On the Release policies main page, detailed ToC also seems redundant. Links to both the new release policy and the legacy one are obvious from the summary text.

  3. Release notes main page ToC:
    I would rename the Versions item and the title on the corresponding page to something like Release notes on Tarantool versions.
    Otherwise, when you look at the current ToC, it's hard to guess where the main thing is—the release notes themselves.

@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 15, 2022 08:05 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 15, 2022 09:39 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 15, 2022 09:48 Inactive
This is a blueprint for #2750.
@patiencedaur patiencedaur force-pushed the patiencedaur/gh-2734-release-notes branch from 2a9fa25 to 5590a8b Compare March 15, 2022 11:13
@github-actions github-actions bot temporarily deployed to branch-gh-2734-release-notes March 15, 2022 11:14 Inactive
@patiencedaur
Copy link
Contributor Author

@arctic-dreamer, @veod32, thank you for your suggestions! Does it look good now?

@patiencedaur patiencedaur merged commit 4a99c28 into latest Mar 16, 2022
@patiencedaur patiencedaur deleted the patiencedaur/gh-2734-release-notes branch March 16, 2022 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the Release Notes section
4 participants