From 337f6528bfa89d946c7c084fe8b07fc85b23fc82 Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Sat, 8 Apr 2023 01:27:10 +0200 Subject: [PATCH] docs: describe v1.x end of life (2023-01-06) [skip ci] --- docs/content/index.md | 9 +++++---- docs/content/migration.md | 1 - docs/mkdocs.yml | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/index.md b/docs/content/index.md index 8b8b5ae..8601447 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -18,6 +18,11 @@ +!!! warning "v1.x End of Life (2023-01-06)" + The [`v1.19.4`](https://github.com/static-web-server/static-web-server/releases/tag/v1.19.4) was the last version of the 1.x series and will be no longer supported.
+ So we encourage users to migrate to v2 which has similar and additional features as well as significant performance and security improvements. Follow [the v2 migration steps](./migration.md). + + ## Overview **Static Web Server** (or **`SWS`** abbreviated) is a very small and fast production-ready web server suitable to serve static web files or assets. @@ -30,10 +35,6 @@ It's cross-platform and available for Linux, macOS, Windows and FreeBSD (`x86`,` ![static-web-server](https://user-images.githubusercontent.com/1700322/152613820-658f025c-d0a4-46b3-aa6d-bdc7f638ce77.png) -!!! tip "Tips" - - If you're looking for `v1` please go to [1.x branch](https://github.com/static-web-server/static-web-server/tree/1.x). - - If you want to migrate from `v1` to `v2` please take a look at [v2.0.0](https://github.com/static-web-server/static-web-server/releases/tag/v2.0.0) release notes. - ## Features - Built with [Rust](https://rust-lang.org) which is focused on [safety, speed and concurrency](https://kornel.ski/rust-c-speed). diff --git a/docs/content/migration.md b/docs/content/migration.md index 0c78841..911a276 100644 --- a/docs/content/migration.md +++ b/docs/content/migration.md @@ -9,7 +9,6 @@ However, it still tries to keep the same principles of its `v1`: lightness and e This major `v2` has few breaking changes. However, migration should not represent a problem. - !!! tip "Tip" It is always worth recommending that you test a major server version upgrade like this first with your application(s) in a development environment or similar. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3349c40..af79aa2 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -147,9 +147,9 @@ nav: - 'Trailing Slash Redirect': 'features/trailing-slash-redirect.md' - 'Ignore Files': 'features/ignore-files.md' - 'Platforms & Architectures': 'platforms-architectures.md' - - 'Migration from v1 to v2': 'migration.md' - - 'Changelog v2 (latest stable)': 'https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md' - - 'Changelog v1 (stable)': 'https://github.com/static-web-server/static-web-server/blob/1.x/CHANGELOG.md' + - 'Migrating from v1 to v2': 'migration.md' + - 'Changelog v2 (stable)': 'https://github.com/static-web-server/static-web-server/blob/master/CHANGELOG.md' + - 'Changelog v1 (deprecated)': 'https://github.com/static-web-server/static-web-server/releases/tag/v1.19.4' - 'Semantic Versioning': 'semantic-versioning.md' - 'Contributions': 'contributions.md' - 'License': 'license.md' -- libgit2 1.7.2