https://github.com/openvidu/livekit-tutorials-docs
https://github.com/openvidu/livekit-tutorials-docs
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openvidu/livekit-tutorials-docs
- Owner: OpenVidu
- License: apache-2.0
- Created: 2024-04-29T17:56:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-11T16:43:12.000Z (5 months ago)
- Last Synced: 2025-02-11T17:45:10.904Z (5 months ago)
- Language: Dockerfile
- Size: 22.8 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# livekit-tutorials-docs
Visit at [https://livekit-tutorials.openvidu.io/](https://livekit-tutorials.openvidu.io/).
Create custom Docker image with necessary extra plugings:
```bash
docker build --pull --no-cache --rm=true -t squidfunk/mkdocs-material .
```
Serve:
```bash
docker run --name=mkdocs --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
Build:
```bash
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build
```
## Sync changes between _openvidu.io_ and _livekit-tutorials.openvidu.io_
Whenever any changes are made to the tutorials documentation, theses changes must be also reflected in repository [openvidu.io](https://github.com/OpenVidu/openvidu.io) so they end up available in [openvidu.io/latest/docs/getting-started](https://openvidu.io/latest/docs/getting-started/).
To apply changes in the web _openvidu.io_:
- In this repository, push the changes to tutorials documentation to the `main` branch and run GitHub Action [Publish Web](https://github.com/OpenVidu/livekit-tutorials-docs/actions/workflows/publish-web.yaml) selecting the `main` branch.
- In repository [openvidu.io](https://github.com/OpenVidu/openvidu.io), push the changes to the `main` branch and run GitHub Action to [overwrite the latest version](https://github.com/OpenVidu/openvidu.io#overwriting-the-latest-version).