Skip to content

docs: add ADR infrastructure and first ADRs#1945

Merged
BareosBot merged 3 commits intobareos:masterfrom
arogge:dev/arogge/master/adr
Sep 12, 2024
Merged

docs: add ADR infrastructure and first ADRs#1945
BareosBot merged 3 commits intobareos:masterfrom
arogge:dev/arogge/master/adr

Conversation

@arogge
Copy link
Member

@arogge arogge commented Aug 30, 2024

As the title sais. Add ADR directory, template and a readme that describes the process.
Also add ADRs for

  • writing ADRs at all
  • using MADR format for ADRs
  • using plaintext for resource item descriptions

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)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Required backport PRs have been created
  • Correct milestone is set
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR

@arogge arogge added this to the 24.0.0 milestone Aug 30, 2024
@arogge arogge self-assigned this Aug 30, 2024
@arogge arogge force-pushed the dev/arogge/master/adr branch from 25593a9 to ad511f6 Compare September 2, 2024 09:13
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

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

Great work, and improvement to the project ...
Can you check my comment about .adr-dir ?

@bruno-at-bareos bruno-at-bareos self-requested a review September 2, 2024 14:14
@bruno-at-bareos
Copy link
Contributor

I believe we should introduce ADR into the documentation. But that maybe into a second stage.

Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

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

As discussed and not forget : a note need to be added to documentation mentioning the fact that we are using ADR now.
It is certainly more devoted to devs, but may have an general interest for users to followup changes?

Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the documentation addition. This PR is now ready for merge

@BareosBot BareosBot force-pushed the dev/arogge/master/adr branch from 1483327 to 60d7c7f Compare September 12, 2024 14:52
@BareosBot BareosBot merged commit fec727f into bareos:master Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants