OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-14 10:32:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update contributing tutorial in feature branch

Browse Source
This commit is contained in:
Matthew Hand 2024-11-06 20:06:59 +00:00
parent f7c92cb7ae
commit 5c9623dd6f
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/tutorials/tips/contributing-tutorial.md
View File

@ -18,7 +18,19 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
- Navigate to the [Open WebUI Docs Repository](https://github.com/open-webui/docs) on GitHub. - Navigate to the [Open WebUI Docs Repository](https://github.com/open-webui/docs) on GitHub.
- Click the **Fork** button at the top-right corner to create a copy under your GitHub account. - Click the **Fork** button at the top-right corner to create a copy under your GitHub account.
2. **Configure GitHub Environment Variables** 2. **Enable GitHub Actions**
- In your forked repository, navigate to the **Actions** tab.
- If prompted, enable GitHub Actions by following the on-screen instructions.
3. **Enable GitHub Pages**
- Go to **Settings** > **Pages** in your forked repository.
- Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`).
- Click **Save** to enable GitHub Pages.
4. **Configure GitHub Environment Variables**
- In your forked repository, go to **Settings** > **Secrets and variables** > **Actions** > **Variables**. - In your forked repository, go to **Settings** > **Secrets and variables** > **Actions** > **Variables**.
- Add the following environment variables: - Add the following environment variables:
@ -53,17 +65,6 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
``` ```
- This setup ensures consistent deployment behavior for forks and custom setups. - This setup ensures consistent deployment behavior for forks and custom setups.
3. **Enable GitHub Actions**
- In your forked repository, navigate to the **Actions** tab.
- If prompted, enable GitHub Actions by following the on-screen instructions.
4. **Enable GitHub Pages**
- Go to **Settings** > **Pages** in your forked repository.
- Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`).
- Click **Save** to enable GitHub Pages.
5. **Run the `gh-pages` GitHub Workflow** 5. **Run the `gh-pages` GitHub Workflow**
- In the **Actions** tab, locate the `gh-pages` workflow. - In the **Actions** tab, locate the `gh-pages` workflow.