Skip to content

Commit

Permalink
add changelog and migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
wochinge committed Dec 9, 2020
1 parent 9e8a0a4 commit 24c1b5c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
15 changes: 15 additions & 0 deletions changelog/7495.removal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Deprecate training and test data in Markdown format. This includes:
- reading and writing of story files in Markdown format
- reading and writing for NLU data in Markdown format
- reading and writing of retrieval intent data in Markdown format

Support for Markdown data will be removed entirely in Rasa Open Source 3.0.0.

Please convert your existing Markdown data by using the commands
from the [migration guide](./migration-guide.mdx#rasa-21-to-rasa-22):

```bash
rasa data convert nlu -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}
rasa data convert nlg -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}
rasa data convert core -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}
```
16 changes: 15 additions & 1 deletion docs/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@ description: |
This page contains information about changes between major versions and
how you can migrate from one version to another.

## Rasa 2.1 to Rasa 2.2

### Deprecations

Training and test data in Markdown format is now deprecated. This includes:
- reading and writing of story files in Markdown format
- reading and writing of NLU data in Markdown format
- reading and writing of retrieval intent data in Markdown format

Support for Markdown data will be removed entirely in Rasa Open Source 3.0.0.

Please convert your existing Markdown data by using the commands
described [here](./migration-guide.mdx#training-data-files).

## Rasa 2.0 to Rasa 2.1

### Deprecations
Expand Down Expand Up @@ -52,7 +66,7 @@ in the [forum](https://forum.rasa.com/t/rasa-open-source-2-0-is-out-now-internal
### Training data files

As of version 2.0, the new default training data format is yaml. Markdown is still supported,
but this will be deprecated in a future release.
but this will be deprecated in Rasa Open Source 3.0.0.

You can convert existing NLU, Stories, and NLG (i.e. `responses.md`) training data
files in the Markdown format to the new YAML format using following commands:
Expand Down

0 comments on commit 24c1b5c

Please sign in to comment.