diff options
Diffstat (limited to 'source/includes')
| -rw-r--r-- | source/includes/container_dev_env.inc.rst | 14 | ||||
| -rw-r--r-- | source/includes/footer.inc.rst | 22 | ||||
| -rw-r--r-- | source/includes/substitution_definitions.inc.rst | 72 |
3 files changed, 108 insertions, 0 deletions
diff --git a/source/includes/container_dev_env.inc.rst b/source/includes/container_dev_env.inc.rst new file mode 100644 index 0000000..8b30296 --- /dev/null +++ b/source/includes/container_dev_env.inc.rst @@ -0,0 +1,14 @@ +.. note:: + + The rsyslog project maintains multiple `rsyslog docker development + environment images <https://hub.docker.com/u/rsyslog/>`_. These + images have been configured specifically for use with rsyslog and are + recommended over your own build environment. Rsyslog docker development + images are named with the ``rsyslog_dev_`` prefix, followed by the + distro name. + +.. warning:: + + If you plan to copy the binary for use outside of the container you need + to make sure to use an image of the same distro/version when building + rsyslog. diff --git a/source/includes/footer.inc.rst b/source/includes/footer.inc.rst new file mode 100644 index 0000000..be102e6 --- /dev/null +++ b/source/includes/footer.inc.rst @@ -0,0 +1,22 @@ + + +.. seealso:: + + Help with configuring/using |PRODUCT|: + + - |RsyslogOfficialMailingList|_ - best route for general questions + + - GitHub: |GitHubSourceProject|_ - detailed questions, reporting issues + that are believed to be bugs with |PRODUCT| + +.. seealso:: + + Contributing to |PRODUCT|: + + - Source project: |GitHubSourceProjectREADME|_. + - Documentation: |GitHubDocProjectREADME|_ + + +Copyright 2008-2023 `Rainer Gerhards <https://rainer.gerhards.net/>`__ +(`Großrinderfeld <https://www.rainer-gerhards.de/grossrinderfeld/>`__), +and Others. diff --git a/source/includes/substitution_definitions.inc.rst b/source/includes/substitution_definitions.inc.rst new file mode 100644 index 0000000..1ba41cd --- /dev/null +++ b/source/includes/substitution_definitions.inc.rst @@ -0,0 +1,72 @@ + +.. + This file is included by the common header file, which is itself + included by means of the rst_prolog Sphinx build confiugration + file (source/conf.py). Add substitutions here instead of directly to + the rst_prolog configuration option. + + +.. |PRODUCT| replace:: ``Rsyslog`` + +.. |FmtBasicName| replace:: ``basic`` +.. |FmtAdvancedName| replace:: ``advanced`` +.. |FmtObsoleteName| replace:: ``obsolete legacy`` + +.. |FmtObsoleteDescription| replace:: ``Obsolete Format Equivalents`` + +.. |RsyslogDockerHub| replace:: official rsyslog Docker Hub +.. _RsyslogDockerHub: https://hub.docker.com/u/rsyslog/ + +.. |GitHubDockerProject| replace:: rsyslog-docker project +.. _GitHubDockerProject: https://github.com/rsyslog/rsyslog-docker + +.. |DockerApplianceAlpineDockerHubRepo| replace:: Alpine rsyslog appliance Docker Hub repo +.. _DockerApplianceAlpineDockerHubRepo: https://hub.docker.com/r/rsyslog/syslog_appliance_alpine/ + +.. |DockerApplianceAlpineName| replace:: ``rsyslog/syslog_appliance_alpine`` +.. |DockerApplianceAlpineRUN| replace:: ``docker run -ti rsyslog/syslog_appliance_alpine`` + + +.. |RsyslogPackageDownloads| replace:: rsyslog package downloads +.. _RsyslogPackageDownloads: http://www.rsyslog.com/downloads/download-other/ + +.. |GitHubDocProject| replace:: rsyslog-doc project +.. _GitHubDocProject: https://github.com/rsyslog/rsyslog-doc/ + +.. |GitHubDocProjectREADME| replace:: rsyslog-doc project README +.. _GitHubDocProjectREADME: https://github.com/rsyslog/rsyslog-doc/blob/master/README.md + +.. |GitHubDocProjectDevREADME| replace:: rsyslog-doc project BUILDS README +.. _GitHubDocProjectDevREADME: https://github.com/rsyslog/rsyslog-doc/blob/master/BUILDS_README.md + +.. |GitHubDocProjectGoodFirstIssueLabel| replace:: rsyslog-doc issues marked with Good First Issue label +.. _GitHubDocProjectGoodFirstIssueLabel: https://github.com/rsyslog/rsyslog-doc/labels/good%20first%20issue + + +.. |GitHubDocProjectHelpWantedLabel| replace:: rsyslog-doc issues marked with Help Wanted label +.. _GitHubDocProjectHelpWantedLabel: https://github.com/rsyslog/rsyslog-doc/labels/help%20wanted + +.. |RsyslogOfficialForums| replace:: Forum +.. _RsyslogOfficialForums: http://kb.monitorware.com/rsyslog-f40.html + +.. |RsyslogStackExchangeAsk| replace:: Ask +.. _RsyslogStackExchangeAsk: https://serverfault.com/questions/ask?tags=rsyslog + +.. |RsyslogStackExchangeView| replace:: View +.. _RsyslogStackExchangeView: https://stackexchange.com/filters/327462/rsyslog + +.. |RsyslogOfficialMailingList| replace:: Mailing list +.. _RsyslogOfficialMailingList: http://lists.adiscon.net/mailman/listinfo/rsyslog + + +.. |GitHubSourceProject| replace:: rsyslog source project +.. _GitHubSourceProject: https://github.com/rsyslog/rsyslog/ + +.. |GitHubSourceProjectREADME| replace:: rsyslog project README +.. _GitHubSourceProjectREADME: https://github.com/rsyslog/rsyslog/blob/master/README.md + +.. |GitHubSourceProjectGoodFirstIssueLabel| replace:: rsyslog issues marked with Good First Issue label +.. _GitHubSourceProjectGoodFirstIssueLabel: https://github.com/rsyslog/rsyslog/labels/good%20first%20issue + +.. |GitHubSourceProjectHelpWantedLabel| replace:: rsyslog issues marked with Help Wanted label +.. _GitHubSourceProjectHelpWantedLabel: https://github.com/rsyslog/rsyslog/labels/help%20wanted |