Skip to content

docs: reorganize installation chapter and related#1203

Closed
bruno-at-bareos wants to merge 10 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/doc/overall_cleanup_1
Closed

docs: reorganize installation chapter and related#1203
bruno-at-bareos wants to merge 10 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/doc/overall_cleanup_1

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Jul 7, 2022 •
edited
Loading

This PR aims to cleanup our documentation and included some long awaited task.
It has serve as skeleton for numerous small changes, and as everything has been merged since, it can get retired now.

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)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
  • If backport: add original PR number and target branch at top of this file: Backport of PR#000 to bareos-2x
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
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing
Tests
  • Decision taken that a test is required (if not, then remove this paragraph)
  • The choice of the type of test (unit test or systemtest) is reasonable
  • Testname matches exactly what is being tested
  • On a fail, output of the test leads quickly to the origin of the fault

@bruno-at-bareos bruno-at-bareos added nobuild draft documentation This PR changes only documentation labels Jul 7, 2022
@bruno-at-bareos bruno-at-bareos self-assigned this Jul 7, 2022
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch 2 times, most recently from cdbc436 to 744d68b Compare July 11, 2022 14:06
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch 3 times, most recently from c1d715c to a5dec89 Compare July 21, 2022 12:45
@bruno-at-bareos bruno-at-bareos marked this pull request as draft July 21, 2022 12:45
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch 2 times, most recently from 261f607 to 4da9687 Compare July 27, 2022 12:45
@bruno-at-bareos bruno-at-bareos mentioned this pull request Aug 9, 2022
Merged
12 tasks
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch 3 times, most recently from a64c564 to 48874d9 Compare August 11, 2022 12:23
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Aug 11, 2022 •
edited
Loading

@joergsteffens I would like to have your thoughts on the changes made here, especially about the still present table located at
OperatingSystems

All the content has been migrated to Installation chapter. Shall we also move that table as reference below (or on top) installation chapter ?

If you want you can also volunteer as reviewer ;-)

@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch from 48874d9 to 26c313a Compare August 11, 2022 13:57
joergsteffens
joergsteffens reviewed Aug 12, 2022
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 left some initial remarks. If you which, I can also do a full review. However, I think it makes sense to split this PR.

Additional remarks:

  • Install on Univention Corporate Server
    • Special Univention Corporate Server are no longer provided. Instead Debian packages should be used. Therefore this chapter should get replaced by a small hint, explaining this.
  • I see that you updated the Debian install instructions, as required for newer versions of Debian. However it now even gets more complicated. I think we can make this a bit easier by providing more config files in our repository. To test this, it would make sense to split this in a seperate PR.
  • I think the installation chapter should distinguish between server and client only installations. Maybe strictly splitting them in different chapters??? We can discuss this.
  • While it is good that you added information for bareos.com customers, I think they still got it harder to find the required information. Maybe we find a way to make installation easier for them. Extra chapter for installing bareos.com? Of course, this would be partly redundant.

@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch 2 times, most recently from e91d3ad to e1f7401 Compare August 16, 2022 12:27
@bruno-at-bareos bruno-at-bareos changed the title [WIP] docs: overall cleanup docs: reorganize installation chapter and related Aug 16, 2022
@bruno-at-bareos bruno-at-bareos marked this pull request as ready for review August 16, 2022 12:29
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch from e57e167 to b7873f0 Compare August 22, 2022 08:28
joergsteffens
joergsteffens requested changes Aug 22, 2022
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.

Besides of this we still got the topics:

  • Keeping the "Installing Bareos" section separate between Bareos server and client only installations.
  • Univention Corporate Server no longer with special integration. Section can be replaced with a hint about this and a hint about how to use UCS5
  • Handling of Debian installations

bruno-at-bareos
bruno-at-bareos commented Aug 22, 2022
View reviewed changes
bruno-at-bareos
bruno-at-bareos commented Aug 22, 2022
View reviewed changes
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Aug 22, 2022

  • Did you have example or suggestion for this topic "Univention Corporate Server no longer with special integration. Section can be replaced with a hint about this and a hint about how to use UCS5" ?
  • For Debian once we have the internal new helper ready the section can be simplified
  • About the split this is on the next dev meeting agenda

bruno-at-bareos and others added 10 commits August 22, 2022 16:56
@bruno-at-bareos
docs: Installation chapter introduce subscription repositories.
2f49f64 
- Remove no more relevant database type dbconfig printscreen.
- Fix typos, used better formulation.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos
docs: add mkdir before creating file
3d140df
@bruno-at-bareos
docs: new hardened installation instructions for .deb platform
19cfc60 
- remove the use of obsolete apt-key.
- promote the use of apt auth configuration.
- unify process for all repository.
- use dedicated Bareos variables.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos
docs: move Mac OSX, ULC, Univention to Installation Chapter.
4529789 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @joergsteffens
renew Debian/Ubuntu section
096af36 
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
@bruno-at-bareos @joergsteffens
reword Windows pointer section and fix title length
6d51913 
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
@bruno-at-bareos
docs: Appendix/OS update windows version to current.
9fbec13 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos
Apply review suggestions
f18efcb 
- fix url for subscription
- enhance OS/packages table

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos
update CHANGELOG.md for PR#1203
53565b0 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @joergsteffens
Apply suggestions from code review
6501ffc 
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/doc/overall_cleanup_1 branch from 6311c60 to 6501ffc Compare August 22, 2022 14:57
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Sep 1, 2022

Waiting PR #1238 to be merged before restructuring further.

@bruno-at-bareos bruno-at-bareos marked this pull request as draft September 8, 2022 15:00
@bruno-at-bareos bruno-at-bareos mentioned this pull request Sep 9, 2022
Merged
8 tasks
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Sep 29, 2022

The only changes missing (deleting docs/manuals/source/include/images/dbconfig-2-select-database-type.png) will be operated into a clean new PR.

@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/doc/overall_cleanup_1 branch November 15, 2022 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joergsteffens joergsteffens joergsteffens requested changes

Assignees

@bruno-at-bareos bruno-at-bareos

Labels

documentation This PR changes only documentation nobuild onhold

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bruno-at-bareos @joergsteffens