Skip to content

docs: improve bareos-webui documentation#1366

Merged
joergsteffens merged 3 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor
Feb 8, 2023
Merged

docs: improve bareos-webui documentation#1366
joergsteffens merged 3 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Feb 2, 2023 •
edited by joergsteffens
Loading

This PR aims to merge both chapter bareos-webui and bareos-webui-install(update).
With this move, end-user should find all webui related information in one place.

  • merge BareosWebuiInstall.rst into BareosWebui.rst
  • add instruction for AppArmor protected system
  • Fix Bareos links redirection issues in WhatIsBareos.rst

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
  • Check backport line

@bruno-at-bareos bruno-at-bareos added documentation This PR changes only documentation requires backport to 22 labels Feb 2, 2023
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor branch from af9185b to 6b5c129 Compare February 2, 2023 14:29
joergsteffens
joergsteffens requested changes Feb 7, 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.

Looks good. I just found one typo. The other suggestions just remove information about outdated versions.
Maybe you can additonally remove section https://download.bareos.org/experimental/PR-1366/BareosMainReference/TasksAndConcepts/TransportEncryption.html#configuration-example-for-bareos-17-2 ?

And I'm unsure where the best place for this chapter will be. An alternative would be after the tuturial chapter.

@joergsteffens joergsteffens assigned joergsteffens and unassigned frb121 Feb 7, 2023
@joergsteffens
Copy link
Member

joergsteffens commented Feb 7, 2023

The pr-tool complains:

 ✗  bareos-check-sources --since=47d9cdbd98cb28a0d6cabf2391b82884c6a35fd0 reported:
	Plugin 'trailing newlines' would modify 'docs/manuals/source/IntroductionAndTutorial/BareosWebui.rst'

Also I think the commit messages should start with "docs:".

@bruno-at-bareos bruno-at-bareos changed the title doc: improve bareos-webui documentation docs: improve bareos-webui documentation Feb 8, 2023
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Feb 8, 2023

I've fixed the new lines and also changed the PR subject to start with docs:
@joergsteffens shall I do a squash of commits before you go for green light?

@joergsteffens
Copy link
Member

joergsteffens commented Feb 8, 2023

Yes, please. What about my other two remarks from #1366 (review)
Do you want to keep it the way it is?

@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Feb 8, 2023

Yes, please. What about my other two remarks from #1366 (review) Do you want to keep it the way it is?

No, thanks for the reminders. At least I will remove the obsolete 17 part.

@bruno-at-bareos @joergsteffens
docs: improve bareos-webui chapter
dec285c 
- insert apparmor php-fpm config example
- renew indexes syntax
- Reorder sections and title level
- move Bareos Webui chapter after update/upgrade
- rework content by merging the install and update chapter
- delete unused InstallingBareosWebui.rst
- fix redirection issues with bareos links
- more cleanup removing obsoleted sections
- add section about transport encryption

Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor branch from 2ec862d to 6e4aa90 Compare February 8, 2023 12:54
joergsteffens
joergsteffens reviewed Feb 8, 2023
View reviewed changes
docs/manuals/source/TasksAndConcepts/TransportEncryption.rst Outdated



Configuration example for Bareos 18.2
Copy link
Member

@joergsteffens joergsteffens Feb 8, 2023

Choose a reason for hiding this comment

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

Suggested change
Configuration example for Bareos 18.2
Configuration example

Copy link
Member

@joergsteffens joergsteffens Feb 8, 2023

Choose a reason for hiding this comment

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

And could you please also prepend the git commit message with "docs:" ? Or also squash them together.

Copy link
Contributor Author

@bruno-at-bareos bruno-at-bareos Feb 8, 2023

Choose a reason for hiding this comment

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

all done in last push.

@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor branch 2 times, most recently from 9d03258 to f159c50 Compare February 8, 2023 16:04
@bruno-at-bareos
docs: remove obsolete pre-17 bareos-webui section
03f6a46 
- remove unused final note

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor branch from f159c50 to 03f6a46 Compare February 8, 2023 16:17
@joergsteffens joergsteffens merged commit 06f68d7 into bareos:master Feb 8, 2023
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/s5387-doc-note-about-php-fpm-apparmor branch March 1, 2023 12:57
@bruno-at-bareos bruno-at-bareos mentioned this pull request Mar 29, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joergsteffens joergsteffens joergsteffens approved these changes

@frb121 frb121 Awaiting requested review from frb121

Assignees

@joergsteffens joergsteffens

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.

3 participants

@bruno-at-bareos @joergsteffens @frb121