Skip to content

Commit

Permalink
Rename release notes to upgrade
Browse files Browse the repository at this point in the history
* Add top-level doc on upgrading considerations
  • Loading branch information
Mark Bonsack committed Feb 3, 2020
1 parent 1f3e1ee commit 028f98b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
12 changes: 0 additions & 12 deletions docs/release.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 028f98b

Please sign in to comment.