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.

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

docs: split plugin file into chapter files #1046

Merged
merged 2 commits into from
Jan 18, 2022

Conversation

DjamilaMamedov
Copy link
Contributor

@DjamilaMamedov DjamilaMamedov commented Jan 14, 2022

The Plugin.rst file has been split into the chapterfiles: DirectorPlugins.rst.inc, FileDaemonPlugins.rst.inc and StorageDaemonPlugins.rst.inc .
The chapterfiles had been split into one file per plugin.

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
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

@joergsteffens joergsteffens self-assigned this Jan 17, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
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.

I've made some suggestion to also fix all index syntax to use the sphinx one.
I think that mariadbplugin.rst can be remove as it serve nothing useful.

docs/manuals/source/TasksAndConcepts/Plugins.rst Outdated Show resolved Hide resolved
.. include:: Plugins/FileDaemonPlugins/GlusterFsPlugin.rst.inc
.. include:: Plugins/FileDaemonPlugins/LdapPlugin.rst.inc
.. include:: Plugins/FileDaemonPlugins/MariaDBmariabackupPlugin.rst.inc
.. include:: Plugins/FileDaemonPlugins/MariaDBPlugin.rst.inc
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. include:: Plugins/FileDaemonPlugins/MariaDBPlugin.rst.inc

There's nothing useful inside it, Corresponding file should be removed

@@ -0,0 +1,4 @@
MariaDB Plugin
Copy link
Contributor

Choose a reason for hiding this comment

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

This file need to be removed, nothing useful in.

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.

There's still some needed changes, as I found some mispelled lower/upper case name in plugin file name.
The following files need to be renamed.
Problem with lower/upper case name of split plugin files

  • docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/GlusterFsPlugin.rst.inc -> GlusterFSPlugin.rst.inc
  • docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/LdapPlugin.rst.inc -> LDAPPlugin.rst.inc
  • docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/MsSqlPlugin.rst.inc -> MSSqlPlugin.rst.inc
  • docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/MySqlPlugin.rst.inc -> MySQL.rst.inc
  • docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/PostgreSqlPlugin.rst.inc -> PostgreSQLPlugin.rst.inc

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.

The build doc fail actually and that need to be fixed.

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.

None yet

3 participants