diff --git a/docs/release.md b/docs/release.md deleted file mode 100644 index fdf5c6b..0000000 --- a/docs/release.md +++ /dev/null @@ -1,12 +0,0 @@ -# Release Notes - -Splunk Connect for Syslog is updated regularly using a CI/CD development process. Check back often for the latest on each release -here. Changes that will affect current installations, as well as new and deprecated features, will be outlined below. - -## Version 1.9.0 - -* Version string added -* Example context files added to local mount. These example files will be updated at each release to add support for new data sources, -and the new content can be added to existing context files (without the `.example` extension). Existing context files will _not_ be -overwritten on subsequent SC4S starts/upgrades, so ensure that content for new data sources is incorporated in existing context files. -* Support for Cisco devices sending events with no hostname has been added. diff --git a/docs/upgrade.md b/docs/upgrade.md new file mode 100644 index 0000000..38b1a0d --- /dev/null +++ b/docs/upgrade.md @@ -0,0 +1,12 @@ +# Upgrading Splunk Connect for Syslog + +Splunk Connect for Syslog is updated regularly using a CI/CD development process. The notes below outline significant changes that +must be taken into account prior and after an upgrade. Ensure to follow specific instructions below to ensure a smooth transition to +a new version of SC4S in production. + +## Version 1.9.0 + +Example context files have been added to the local mount `context` directory. These example files will be updated at each release +to outline support for new data sources, which can be added to existing context files (those without the `.example` extension). +Existing context files will _not_ be overwritten on subsequent SC4S starts/upgrades, so ensure that any new content from these example +files is incorporated into existing context files. diff --git a/mkdocs.yml b/mkdocs.yml index 8ae29c6..8f18791 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,7 +32,7 @@ nav: - 'Demo Lab': 'demo.md' - Performance: 'performance.md' - Troubleshooting: 'troubleshooting.md' - - 'Release Notes': 'release.md' + - 'Upgrading SC4S': 'upgrade.md' markdown_extensions: - toc: