https://github.com/openvidu/livekit-tutorials-docs

https://github.com/openvidu/livekit-tutorials-docs

Last synced: about 1 month 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 (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-05T18:10:12.000Z (about 2 months ago)
• Last Synced: 2024-11-05T18:36:41.340Z (about 2 months ago)
• Language: Dockerfile
• Size: 22.6 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• 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

```

## Updating tutorials

Whenever any changes are made to the tutorials documentation, theses changes must be also reflected in the "tutorials" section of the official OpenVidu documentation, which is located in the [openvidu.io repository](https://github.com/OpenVidu/openvidu.io).

In order to publish the changes in the tutorials, follow these steps:

-   In this repository, push the changes to the `main` branch, go to `Actions` and run the workflow named "Publish Web" selecting the `main` branch.

-   In the [openvidu.io repository](https://github.com/OpenVidu/openvidu.io), push the changes to the `main` branch and execute the script [Overwriting the latest version](https://github.com/OpenVidu/openvidu.io#overwriting-the-latest-version) to update the latest version of the documentation.