-
Notifications
You must be signed in to change notification settings - Fork 259
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
Conversation
2cccede
to
efe35e6
Compare
There was a problem hiding this 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/FileDaemonPlugins.rst.inc
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. include:: Plugins/FileDaemonPlugins/MariaDBPlugin.rst.inc |
There's nothing useful inside it, Corresponding file should be removed
@@ -0,0 +1,4 @@ | |||
MariaDB Plugin |
There was a problem hiding this comment.
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.
docs/manuals/source/TasksAndConcepts/Plugins/StorageDaemonPlugins/AutoxflateSd.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/StorageDaemonPlugins/PythonSdPlugin.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/StorageDaemonPlugins/ScsicryptoSd.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/StorageDaemonPlugins/ScsitapealertSd.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/DirectorPlugins/PythonDirPlugin.rst.inc
Outdated
Show resolved
Hide resolved
c40b297
to
cfdda1d
Compare
There was a problem hiding this 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
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins.rst.inc
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins.rst.inc
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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.
f487bc5
to
3a27c83
Compare
3a27c83
to
003b468
Compare
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
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
Source code quality
[ ] Source code changes are understandable[ ] Variable and function names are meaningfulbareos-check-sources --since-merge
does not report any problemsgit status
should not report modifications in the source tree after building and testing