Skip to content

docs: improve Restoring a Bareos Server section#1878

Merged
BareosBot merged 2 commits intobareos:masterfrom
UraniumDonut:patch-2
Jul 8, 2024
Merged

docs: improve Restoring a Bareos Server section#1878
BareosBot merged 2 commits intobareos:masterfrom
UraniumDonut:patch-2

Conversation

@UraniumDonut
Copy link
Contributor

@UraniumDonut UraniumDonut commented Jul 2, 2024

  • Added a point about importing the Catalog Backup.
  • Changed the next point to be syntactially correct.

Thank you for contributing to the Bareos Project!

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
  • Required documentation changes are present and part of the PR

@bruno-at-bareos bruno-at-bareos added documentation This PR changes only documentation labels Jul 2, 2024
@bruno-at-bareos bruno-at-bareos self-assigned this Jul 2, 2024
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 for your suggestion, I've a slightly different fix you may want to apply.

@bruno-at-bareos
Copy link
Contributor

bruno-at-bareos commented Jul 4, 2024

Also now the build doc has tried there's some failures you want to fix

✗  Commit checks failed:

338cc00b5 Update AUTHORS: missing newline at end of headline
e45e7deab Update DisasterRecoveryUsingBareos.rst with info on how to ingest the Catalog Backup: missing newline at end of headline
e45e7deab Update DisasterRecoveryUsingBareos.rst with info on how to ingest the Catalog Backup: headline too long

@UraniumDonut
Copy link
Contributor Author

Thanks for the hints!
As I have no idea how to edit existing commit messages, I will re-open a new PR with the new changes and proper line endings.

@bruno-at-bareos
Copy link
Contributor

Reopened, fixes will goes there as all the other parameters are already in place. (tagging project labels etc)

@bruno-at-bareos
Copy link
Contributor

To change your commit you may simply want to rebase and adjust the changes.
We normally don't like to have a force push but in that case as there's only 2 commits, it will not be important.

So in your clone, be sure you have a fresh master (git switch master && git pull) then back to your branch you can
play with git rebase -i master

Use the reword and edit to apply your changes then you should be able to git push --force your branch

@bruno-at-bareos
Copy link
Contributor

We are working on a way to allow external contributor to have access to build result, I will take care of the message after your submission.

@bruno-at-bareos
Copy link
Contributor

We have this section into the documentation that may help
https://docs.bareos.org/master/DeveloperGuide/gitworkflow.html#commit-message-guideline

For example your commit to the rst can have as subject

doc: improve section recovering Bareos server section

With a body like

Add examples how to load the restored database ascii dump as catalog.

So the subject is short enough (around 50 char) but explicit for the changelog.
(you may want to consult the existing to find similar commit)

Once you have it done, you should also modify the title pr here so it can be also used during the merge.
Don't hesitate to ask help if needed.

@UraniumDonut UraniumDonut force-pushed the patch-2 branch 2 times, most recently from 4a178fd to b240112 Compare July 5, 2024 15:48
@UraniumDonut
Copy link
Contributor Author

I think I managed to change it properly. Thanks for all the tips, I already learned a lot more about git!

@UraniumDonut
Copy link
Contributor Author

UraniumDonut commented Jul 8, 2024

Build still failing :/

@bruno-at-bareos
Copy link
Contributor

Build still failing :/

No in fact, the final review is now needed (which I will take care of today).

@bruno-at-bareos
Copy link
Contributor

Build still failing :/

No in fact, the final review is now needed (which I will take care of today).

And I will fix the warning of our pr-tool
Commit checks failed:
b240112 docs: improve section recovering Bareos server section: body contains line longer 72 chars

If you want to contribute more, it will be interesting to setup a dev environment (see documentation it should be complete), you will find our tools in the devtools subdir.

- add example how to load the restored database ascii dump as catalog
- update the AUTHORS file.
@bruno-at-bareos bruno-at-bareos changed the title Improved documentation about Catalog restore process. docs: improve Restoring a Bareos Server section Jul 8, 2024
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 for the work, Approved.

@BareosBot BareosBot merged commit 6e9f2dd into bareos:master Jul 8, 2024
@UraniumDonut
Copy link
Contributor Author

Thanks for the help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR changes only documentation requires backport to 23

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants