Skip to content
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

docs: release note remove warning about binaries #1354

Merged
merged 3 commits into from
Jan 20, 2023
Merged

docs: release note remove warning about binaries #1354

merged 3 commits into from
Jan 20, 2023

Conversation

bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Jan 12, 2023 •
edited by joergsteffens
Loading

This PR remove the warning section of release note page and add a note to new Binary Policy page to explain more deeply what <next-version-number>~pre is with example.

OP #5373

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Check backport line
  • Is the PR title usable as CHANGELOG entry?
  • Separate commit for CHANGELOG.md ("update CHANGELOG.md"). The PR number is correct.
Source code quality
  • Required documentation changes are present and part of the PR

@bruno-at-bareos bruno-at-bareos added documentation This PR changes only documentation requires backport to 22 labels Jan 12, 2023
joergsteffens
joergsteffens requested changes Jan 16, 2023
View reviewed changes
Copy link
Member

@joergsteffens joergsteffens left a comment

Choose a reason for hiding this comment

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

This is an improvement, but I'd formulate some things differently.

docs/manuals/source/Appendix/ReleaseNotes.rst Outdated Show resolved Hide resolved
docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst Outdated
Bareos Binary Release Policy
----------------------------

.. _section-BareosRepositoryTypes:
Copy link
Member

Choose a reason for hiding this comment

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

Why have moved this below the section title? IMHO it belongs above the title. Multiple section labels are not a problem.

Copy link
Contributor Author

@bruno-at-bareos bruno-at-bareos Jan 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I've to check again, but the linking to that section was not working as expected when below.
But for coherency, the section title BareosRepositoryTypes is now correctly placed, as if we add some content after
Bareos Binary Release Policy like for example time schedule etc, the next section (Repository) would no more be well placed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Don't know what was not working, restested and it works. Would you like to see this title going back before the section?

Copy link
Member

Choose a reason for hiding this comment

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

Either move it above the section title (as this ref is also called "section-") or remove it completely, as it is not used anymore anyway.

docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst Outdated Show resolved Hide resolved
docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst Outdated Show resolved Hide resolved
docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst Outdated Show resolved Hide resolved
joergsteffens
joergsteffens approved these changes Jan 19, 2023
View reviewed changes
Copy link
Member

@joergsteffens joergsteffens left a comment

Choose a reason for hiding this comment

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

I added the CHANGELOG. Fixing the section ref would be nice, but otherwise approved the PR.

docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst Outdated
Bareos Binary Release Policy
----------------------------

.. _section-BareosRepositoryTypes:
Copy link
Member

Choose a reason for hiding this comment

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

Either move it above the section title (as this ref is also called "section-") or remove it completely, as it is not used anymore anyway.

bruno-at-bareos and others added 3 commits January 19, 2023 21:12
@bruno-at-bareos
docs: Release Note remove binaries warning section
1946016 
- since new Bareos Binary Policy for >= 22, warning is none
- add pointer to the corresponding section

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @joergsteffens
docs: Binary Policy add note for next-version~pre
dbcf56c 
- add a note section to explain in detailled human words what's
  behing ~pre binary build in current.
- clarify next major changes in both repositories.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
@joergsteffens @bruno-at-bareos
Update CHANGELOG.md
9699412
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s5373-docs-release-notes-remove-warning-about-binaries branch from a275cdf to 9699412 Compare January 19, 2023 20:13
@bruno-at-bareos
Copy link
Contributor Author

Done.

@joergsteffens joergsteffens merged commit 22a3fef into bareos:master Jan 20, 2023
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/s5373-docs-release-notes-remove-warning-about-binaries branch March 1, 2023 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joergsteffens joergsteffens Awaiting requested review from joergsteffens

Assignees

@joergsteffens joergsteffens

@bruno-at-bareos bruno-at-bareos

Labels
documentation This PR changes only documentation requires backport to 22
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bruno-at-bareos @joergsteffens