Skip to content

Commit

Permalink
Added Documentation for Short Url Redirections
Browse files Browse the repository at this point in the history
  • Loading branch information
SGI-CAPP-AT2 authored Jul 1, 2024
1 parent 8d603db commit 9e00555
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,25 @@ This repository has the following structure:
├── tailwind.config.js # TailwindCSS configuration file
└── tsconfig.json # TypeScript configuration file
```
## Short Url Redirections

Short urls are used in website to make redirections by using a short alias for given address on this website.

These type of urls should be implemented as follows:

1. This website uses address like `/s/:short-alias` to create short urls.

2. Such redirections can be made using the `_redirects` file.
Location of file: `(root)/public/_redirects`

3. These short urls must use the section `SHORT-URL-REDIRECTION` inside the `_redirects`.

An Example url in `_redirects` looks like
```yaml
/s/example https://github.com/asyncapi/spec/blob/master/examples/streetlights-mqtt-asyncapi.yml 301!
```



## Connect with AsyncAPI Community

Expand Down

0 comments on commit 9e00555

Please sign in to comment.