Skip to content

docs: fix the tutorials directory and the env variable order in the contributing tutorial #1434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
silentoplayz wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

docs: fix the tutorials directory and the env variable order in the contributing tutorial #1434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/tutorials/contributing-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
- `BASE_URL` set to `/docs` (or your chosen base URL for the fork).
- `SITE_URL` set to `https://<your-github-username>.github.io/`.

These variables take effect only after the workflow and config edits in the next section: the upstream `gh-pages.yml` build step sets no `env`, and `docusaurus.config.ts` hard-codes `url` and `baseUrl`.

### 📝 Updating the GitHub Pages Workflow and Config File

If you need to adjust deployment settings to fit your custom setup, here’s what to do:
Expand All @@ -63,7 +65,7 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
title: "Open WebUI",
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
favicon: "images/favicon.png",
url: process.env.SITE_URL || "https://openwebui.com",
url: process.env.SITE_URL || "https://docs.openwebui.com",
baseUrl: process.env.BASE_URL || "/",
...
};
Expand All @@ -82,7 +84,7 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**

7. **Draft Your Changes**

- In your forked repository, navigate to the appropriate directory (e.g., `docs/tutorial/`).
- In your forked repository, navigate to the appropriate directory (e.g., `docs/tutorials/`).
- Create a new markdown file for your tutorial or edit existing ones.
- Ensure that your tutorial includes the unsupported warning banner.

Expand Down
Loading