search

rsyslog / rsyslog-doc

documentation for the rsyslog project
Other
99 stars 249 forks source link

Update hard-coded html page references to use Sphinx's doc cross-referencing syntax instead #452

Open deoren opened 6 years ago

deoren commented 6 years ago

Example change:

-see our** `troubleshooting guide <troubleshooting/index.html>`_ **to get started.**
+see our** :doc:`troubleshooting guide <troubleshooting/index>` **to get started.**
rgerhards commented 6 years ago

all of those things are unfortunate left-overs from the hand-crafted HTML doc (just to note the obvious).

deoren commented 6 years ago

Output from running epubcheck (current master branch of IDPF/epubcheck repo) against 8ff5cdf068daa674a59e9b5d4c901b616d9dc3f3:

deoren@ubuntu-testbox:~/dev/rsyslog/rsyslog-doc$ java -jar ../../epubcheck/target/epubcheck.jar build/rsyslog.epub

Validating using EPUB version 3.0.1 rules.
ERROR(CSS-008): build/rsyslog.epub/_static/rsyslog.css(52,12): An error occurred while parsing the CSS: Token '{' not allowed here.
ERROR(CSS-008): build/rsyslog.epub/_static/rsyslog.css(52,41): An error occurred while parsing the CSS: Token '}' not allowed here.
ERROR(RSC-007): build/rsyslog.epub/community.xhtml(46,77): Referenced resource 'licensing.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/community.xhtml(48,85): Referenced resource 'free_support.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(24,125): Referenced resource 'rsyslog_ng_comparison.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(30,83): Referenced resource 'rsyslog_mysql.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(35,76): Referenced resource 'ommail.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(40,113): Referenced resource 'rsyslog_high_database_rate.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(63,74): Referenced resource 'rsyslog_tls.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(64,55): Referenced resource 'rsyslog_tls.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(65,59): Referenced resource 'rsyslog_stunnel.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/features.xhtml(82,59): Referenced resource 'syslog_protocol.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/free_support.xhtml(20,82): Referenced resource 'troubleshooting/index.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/history.xhtml(62,54): Referenced resource 'sample.conf.php' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/development/dev_oplugins.xhtml(48,81): Referenced resource 'development/troubleshoot.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/rainerscript/configuration_objects.xhtml(27,58): Referenced resource 'rainerscript/global.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/recording_pri.xhtml(59,75): Referenced resource 'tutorials/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls.xhtml(34,77): Referenced resource 'tutorials/rsyslog_secure_tls.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls.xhtml(43,96): Referenced resource 'tutorials/rsyslog_stunnel.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls.xhtml(52,53): Referenced resource 'tutorials/gssapi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_client.xhtml(30,98): Referenced resource 'tutorials/tls_cert_ca.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_client.xhtml(33,76): Referenced resource 'tutorials/tls_cert_machine.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_server.xhtml(38,98): Referenced resource 'tutorials/tls_cert_ca.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_server.xhtml(41,76): Referenced resource 'tutorials/tls_cert_machine.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_summary.xhtml(107,80): Referenced resource 'tutorials/tls_cert_scenario.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_udp_relay.xhtml(31,98): Referenced resource 'tutorials/tls_cert_ca.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_udp_relay.xhtml(34,76): Referenced resource 'tutorials/tls_cert_machine.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/tutorials/tls_cert_udp_relay.xhtml(42,111): Referenced resource 'tutorials/tls_cert_client.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/installation/build_from_repo.xhtml(72,68): Referenced resource 'installation/install.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/installation/install_from_source.xhtml(37,93): Referenced resource 'installation/build_from_repo.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/installation/install_from_source.xhtml(128,76): Referenced resource 'installation/v3compatibility.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/installation/install_from_source.xhtml(140,58): Referenced resource 'installation/rsyslog_mysql.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/troubleshooting/troubleshoot.xhtml(39,89): Referenced resource 'troubleshooting/syslog_parsing.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/troubleshooting/troubleshoot.xhtml(238,49): Referenced resource 'troubleshooting/debug.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/compatibility/v4compatibility.xhtml(23,118): Referenced resource 'compatibility/v3compatibility.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/compatibility/v5compatibility.xhtml(30,106): Referenced resource 'compatibility/v4compatibility.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/whitepapers/syslog_parsing.xhtml(236,125): Referenced resource 'whitepapers/rsconf1_rulesetparser.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/whitepapers/syslog_parsing.xhtml(258,122): Referenced resource 'whitepapers/troubleshoot.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/output_channels.xhtml(61,67): Referenced resource 'configuration/log_rotation_fix_size.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/property_replacer.xhtml(18,129): Referenced resource 'configuration/templates.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/property_replacer.xhtml(279,84): Referenced resource 'configuration/rsconf1_escapecontrolcharactersonreceive.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/property_replacer.xhtml(285,84): Referenced resource 'configuration/rsconf1_escapecontrolcharactersonreceive.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/property_replacer.xhtml(293,84): Referenced resource 'configuration/rsconf1_escapecontrolcharactersonreceive.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/property_replacer.xhtml(349,63): Referenced resource 'configuration/rsyslog_conf.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/templates.xhtml(175,73): Referenced resource 'configuration/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/templates.xhtml(177,74): Referenced resource 'configuration/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/templates.xhtml(179,75): Referenced resource 'configuration/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/templates.xhtml(181,75): Referenced resource 'configuration/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/templates.xhtml(183,76): Referenced resource 'configuration/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/ruleset/rsconf1_rulesetcreatemainqueue.xhtml(16,68): Referenced resource 'configuration/ruleset/rsyslog_conf_global.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/ruleset/rsconf1_rulesetcreatemainqueue.xhtml(39,57): Referenced resource 'configuration/ruleset/multi_ruleset.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/ruleset/rsconf1_rulesetparser.xhtml(23,115): Referenced resource 'concepts/messageparser.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/ruleset/rsconf1_rulesetparser.xhtml(61,96): Referenced resource 'configuration/ruleset/omruleset.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/ruleset/rsconf1_rulesetparser.xhtml(119,53): Referenced resource 'configuration/ruleset/pmlastmsg.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/gssapi.xhtml(76,68): Referenced resource 'configuration/modules/imgssapi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imjournal.xhtml(28,58): Referenced resource 'configuration/modules/imuxsock.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imptcp.xhtml(22,59): Referenced resource 'configuration/modules/rsyslog_stunnel.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imtcp.xhtml(20,93): Referenced resource 'configuration/modules/rsyslog_stunnel.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imtcp.xhtml(21,79): Referenced resource 'configuration/modules/imgssapi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imtcp.xhtml(281,91): Referenced resource 'configuration/modules/imgssapi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/imtcp.xhtml(411,91): Referenced resource 'configuration/modules/imgssapi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/mmrfc5424addhmac.xhtml(26,67): Referenced resource 'configuration/modules/mmpstrucdata.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/mmutf8fix.xhtml(50,57): Referenced resource 'configuration/modules/multi_ruleset.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/ommongodb.xhtml(64,82): Referenced resource 'configuration/modules/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/ommysql.xhtml(24,52): Referenced resource 'configuration/modules/omlibdbi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/omoracle.xhtml(30,52): Referenced resource 'configuration/modules/omlibdbi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/ompgsql.xhtml(37,52): Referenced resource 'configuration/modules/omlibdbi.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/omruleset.xhtml(25,76): Referenced resource 'configuration/modules/rainerscript_call.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/omruleset.xhtml(157,107): Referenced resource 'configuration/modules/troubleshoot.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/modules/omuxsock.xhtml(24,94): Referenced resource 'configuration/modules/imuxsock.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/index.xhtml(107,59): Referenced resource 'configuration/global/droppriv.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/index.xhtml(108,59): Referenced resource 'configuration/global/droppriv.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/index.xhtml(109,59): Referenced resource 'configuration/global/droppriv.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/index.xhtml(110,59): Referenced resource 'configuration/global/droppriv.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/options/rsconf1_abortonuncleanconfig.xhtml(16,68): Referenced resource 'configuration/global/options/rsyslog_conf_global.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/options/rsconf1_generateconfiggraph.xhtml(131,62): Referenced resource 'configuration/global/options/troubleshoot.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/global/options/rsconf1_modload.xhtml(28,58): Referenced resource 'configuration/global/options/rsconf1_moddir.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/action/index.xhtml(44,53): Referenced resource 'configuration/action/ommail.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/input_directives/rsconf1_escape8bitcharsonreceive.xhtml(39,118): Referenced resource 'configuration/input_directives/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.xhtml(35,118): Referenced resource 'configuration/input_directives/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/messageparser.xhtml(96,91): Referenced resource 'concepts/syslog_parsing.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/messageparser.xhtml(223,72): Referenced resource 'concepts/imudp.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/messageparser.xhtml(223,134): Referenced resource 'concepts/imtcp.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/messageparser.xhtml(225,45): Referenced resource 'concepts/im3195' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/ns_gtls.xhtml(24,97): Referenced resource 'concepts/ns_ptcp.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/concepts/queues.xhtml(218,70): Referenced resource 'concepts/rsyslog_high_database_rate.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/historical/php_syslog_ng.xhtml(87,115): Referenced resource 'historical/rsyslog_mysql.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/historical/php_syslog_ng.xhtml(89,87): Referenced resource 'historical/rsyslog_conf.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/historical/php_syslog_ng.xhtml(106,69): Referenced resource 'historical/property_replacer.html' could not be found in the EPUB.
ERROR(RSC-007): build/rsyslog.epub/historical/stunnel.xhtml(33,105): Referenced resource 'historical/rsyslog_tls.html' could not be found in the EPUB.

Check finished with errors
Messages: 0 fatal / 90 errors / 0 warnings / 0 info

The master branch build of epubcheck is much more specific about what and where the error is located.