Skip to content

Commit

Permalink
docs: Replace "breaking changes" with DEPRECATED
Browse files Browse the repository at this point in the history
I created DEPRECATED without knowing that there was already a similar
page in the docs. That page was not very visible to developers, with no
mention in the dev docs.

Instead of continuing with the breaking changes file, move relevant
contents into DEPRECATED and automatically render DEPRECATED in the
docs.
  • Loading branch information
victorlin committed Dec 20, 2023
1 parent c137cdd commit e6c2fe4
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 39 deletions.
8 changes: 8 additions & 0 deletions DEPRECATED.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,11 @@ January 2024 or after.*

`augur export v2` was introduced in Augur version 6.0.0. Migrate by following
the [official guide](https://docs.nextstrain.org/projects/augur/page/releases/migrating-v5-v6.html).

## `augur ancestral --output`

*Deprecated in version 5.2.0 (December 2019). Removed in version 7.0.0 (April
2020).*

`--output` was been replaced by `--output-node-data` to accommodate the addition
of `--output-sequences`.
1 change: 1 addition & 0 deletions docs/releases/DEPRECATED.md
38 changes: 0 additions & 38 deletions docs/releases/breaking.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/releases/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and learning what you need to change should be as pain-free as possible.
:glob:

Changelog <changelog>
Deprecated features <DEPRECATED>
v6
migrating-v5-v6
breaking
auspice-compatibility

0 comments on commit e6c2fe4

Please sign in to comment.