483 lines
12 KiB
Rust
483 lines
12 KiB
Rust
//! Embedded Markdown documents for the authenticated Reader.
|
|
|
|
macro_rules! reader_doc {
|
|
($path:literal, $category:literal) => {
|
|
(
|
|
$path,
|
|
$category,
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/", $path)),
|
|
)
|
|
};
|
|
}
|
|
|
|
pub(super) static READER_DOCUMENTS: &[(&str, &str, &str)] = &[
|
|
(
|
|
"README.md",
|
|
"project",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md")),
|
|
),
|
|
(
|
|
"ROADMAP.md",
|
|
"project",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/ROADMAP.md")),
|
|
),
|
|
(
|
|
"CHANGELOG.md",
|
|
"project",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/CHANGELOG.md")),
|
|
),
|
|
(
|
|
"docs/ACME_PROVIDERS.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/ACME_PROVIDERS.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/ACME_RFC2136.md",
|
|
"historical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/ACME_RFC2136.md")),
|
|
),
|
|
(
|
|
"docs/API.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/API.md")),
|
|
),
|
|
(
|
|
"docs/API_ACCESS.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/API_ACCESS.md")),
|
|
),
|
|
(
|
|
"docs/ARCHITECTURE.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/ARCHITECTURE.md")),
|
|
),
|
|
(
|
|
"docs/CACHE.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/CACHE.md")),
|
|
),
|
|
(
|
|
"docs/CACHE_DIAGNOSTICS.md",
|
|
"technical",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/CACHE_DIAGNOSTICS.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/CHANGELOG_TECHNICAL_ARCHIVE.md",
|
|
"historical",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/CHANGELOG_TECHNICAL_ARCHIVE.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/CONTAINER.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/CONTAINER.md")),
|
|
),
|
|
(
|
|
"docs/CUSTOM_LOCATIONS.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/CUSTOM_LOCATIONS.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/DOCKER_DISCOVERY.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/DOCKER_DISCOVERY.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/ERROR_LOGGING.md",
|
|
"technical",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/ERROR_LOGGING.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/FILE_LOGS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/FILE_LOGS.md")),
|
|
),
|
|
(
|
|
"docs/HTTP3.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/HTTP3.md")),
|
|
),
|
|
(
|
|
"docs/INSTALL.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/INSTALL.md")),
|
|
),
|
|
(
|
|
"docs/INTEGRATIONS_040.md",
|
|
"historical",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/INTEGRATIONS_040.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/LIVE_LOGS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/LIVE_LOGS.md")),
|
|
),
|
|
(
|
|
"docs/MANAGEMENT.md",
|
|
"historical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/MANAGEMENT.md")),
|
|
),
|
|
(
|
|
"docs/MIGRATION.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/MIGRATION.md")),
|
|
),
|
|
(
|
|
"docs/MOCK_AUTH.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/MOCK_AUTH.md")),
|
|
),
|
|
(
|
|
"docs/MOCK_SERVER.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/MOCK_SERVER.md")),
|
|
),
|
|
(
|
|
"docs/NOT_FOUND_HOSTS.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/NOT_FOUND_HOSTS.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/NPM_MIGRATION.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/NPM_MIGRATION.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/PHP_FPM.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/PHP_FPM.md")),
|
|
),
|
|
(
|
|
"docs/PROMETHEUS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/PROMETHEUS.md")),
|
|
),
|
|
(
|
|
"docs/README.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/README.md")),
|
|
),
|
|
(
|
|
"docs/REDIRECTS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/REDIRECTS.md")),
|
|
),
|
|
(
|
|
"docs/REFERENCES.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/REFERENCES.md")),
|
|
),
|
|
(
|
|
"docs/RENEWAL.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/RENEWAL.md")),
|
|
),
|
|
(
|
|
"docs/ROADMAP_HISTORY.md",
|
|
"historical",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/ROADMAP_HISTORY.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/SECRET_STORE_BACKUP.md",
|
|
"guides",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/SECRET_STORE_BACKUP.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/SECURITY.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/SECURITY.md")),
|
|
),
|
|
(
|
|
"docs/SECURITY_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/SECURITY_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/SETTINGS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/SETTINGS.md")),
|
|
),
|
|
(
|
|
"docs/STREAMS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/STREAMS.md")),
|
|
),
|
|
(
|
|
"docs/TEST_REPORT.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/TEST_REPORT.md")),
|
|
),
|
|
(
|
|
"docs/TODO.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/TODO.md")),
|
|
),
|
|
(
|
|
"docs/TRANSFORM.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/TRANSFORM.md")),
|
|
),
|
|
(
|
|
"docs/TRANSPORT.md",
|
|
"technical",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/TRANSPORT.md")),
|
|
),
|
|
(
|
|
"docs/V0.21.0_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.21.0_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.22.0_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.22.0_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.22.1_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.22.1_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.22.2_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.22.2_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.22.3_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.22.3_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.23.0_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.23.0_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.23.1_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.23.1_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.23.2_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.23.2_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.23.3_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.23.3_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.0_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.0_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.1_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.1_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.3_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.3_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.4_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.4_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.5_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.5_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.6_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.6_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.7_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.7_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.24.8_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.24.8_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.0_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.0_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.1_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.1_AUDIT.md"
|
|
)),
|
|
),
|
|
reader_doc!("docs/V0.29.0_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.28.2_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.28.1_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.28.0_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.27.3_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.27.2_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.27.1_IMPLEMENTATION.md", "historical"),
|
|
reader_doc!("docs/V0.27.0_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.7_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.6_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.5_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.4_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.3_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.2_IMPLEMENTATION.md", "technical"),
|
|
reader_doc!("docs/V0.26.1_IMPLEMENTATION.md", "technical"),
|
|
(
|
|
"docs/V0.25.5_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.5_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.4_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.4_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.3_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.3_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.2_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.2_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/V0.25.0_SECURITY_PREPROD_AUDIT.md",
|
|
"audits",
|
|
include_str!(concat!(
|
|
env!("CARGO_MANIFEST_DIR"),
|
|
"/docs/V0.25.0_SECURITY_PREPROD_AUDIT.md"
|
|
)),
|
|
),
|
|
(
|
|
"docs/VHOSTS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/VHOSTS.md")),
|
|
),
|
|
(
|
|
"docs/VHOST_ACCESS.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/VHOST_ACCESS.md")),
|
|
),
|
|
(
|
|
"docs/WEB_SERVER.md",
|
|
"guides",
|
|
include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/WEB_SERVER.md")),
|
|
),
|
|
];
|