Skip to content

Commit

Permalink
permalinks for latest docs versions + release guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
m-vdb committed Oct 21, 2021
1 parent 9f4b171 commit 0188ce6
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,10 @@ start the release process (in case anything is missing).
4. **You may now do the release by following the instructions outlined in the
[Rasa Open Source README](#steps-to-release-a-new-version) !**

#### After a Major release

After a Major release has been completed, please follow [these instructions to complete the documentation update](./docs/README.md#manual-steps-after-a-new-version).

### Steps to release a new version
Releasing a new version is quite simple, as the packages are build and distributed by GitHub Actions.

Expand Down
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The docs are built using [Docusaurus 2](https://v2.docusaurus.io/).

## Useful commands

### Installation

```
Expand All @@ -27,3 +29,10 @@ This command generates static content into the `build` directory and can be serv
### Deployment

Deployment is handled by Netlify: it is setup for listening to changes on the `documentation` branch.


## Manual steps after a new version

When a new docs version has been released, we'll need to do the following manual steps:
- Update the wording and links of the top banner, configured in `docusaurus.config.js` in `announcementBar`.
- Update Netlify redirects in `netflify.toml`, under `# Redirects for latest version permalinks`
11 changes: 11 additions & 0 deletions docs/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,17 @@
from = "/docs/rasa/prototype-an-assistant"
to = "/docs/rasa/playground/"

# Redirects for latest version permalinks
# this needs to be updated when we cut a new version
[[redirects]]
from = "/docs/rasa/2.x"
to = "/docs/rasa"

[[redirects]]
from = "/docs/rasa/2.x/*"
to = "/docs/rasa/:splat"
# end permalink section

# FIXME: this requires some feedback as to the 404, like in the website
[[redirects]]
from = "/docs/rasa/*"
Expand Down

0 comments on commit 0188ce6

Please sign in to comment.