[PR #256] [CLOSED] feat: add contributing tutorial and gh-pages workflow #368

New issue

Closed

opened 2026-10-18 14:11:30 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:11:30 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/256
Author: @matthewhand
Created: 10/30/2024
Status: ❌ Closed

Base: main ← Head: feature-contrib-clean

📝 Commits (2)

2ba806a feat: add contributing tutorial and gh-pages workflow
259b5f5 Exclude GitHub Pages workflow from PR as it’s not in upstream

📊 Changes

2 files changed (+84 additions, -55 deletions)

View changed files

➖ .github/workflows/gh-pages.yml (+0 -55)
➕ docs/tutorials/tips/contributing-tutorial.md (+84 -0)

📄 Description

Pull Request Title:

Add Contributing Guidelines and Update GitHub Pages Workflow with Environment Variables

Description:

This pull request introduces two contributions:

Contributing Guidelines:
- Adds a new file at docs/tutorials/tips/contributing-tutorial.md.
- This document provides guidance for contributing code, reporting issues, improving documentation, and engaging with the community.
GitHub Pages Workflow Update:
- Modifies the .github/workflows/gh-pages.yml to support forked repositories by introducing two new environment variables:
  - SITE_URL: Defines the custom site URL used for GitHub Pages deployment.
  - BASE_URL: Configures the base path for deployments.
- These variables ensure forked repositories can use custom URLs for deployments without conflicts.

Files Added/Modified:

docs/tutorials/tips/contributing-tutorial.md
- Provides:
  - Community tutorial contribution practices and best practices.
.github/workflows/gh-pages.yml
- Adds SITE_URL and BASE_URL environment variables to the deployment workflow to enable customized URLs for forked repositories.

Steps to Validate:

Review the Contributing Tutorial:
- Confirm the content in docs/tutorials/tips/contributing-tutorial.md is comprehensive and clear.
- Ensure it aligns with the project's contribution policies and practices.
Test the GitHub Pages Workflow:
- Add the SITE_URL and BASE_URL secrets to your forked repository.
- Push changes to the main branch and confirm the deployment reflects the custom URLs.

Checklist:

Verified the content of the contributing tutorial.
Confirmed the GitHub Pages workflow functions with the environment variables.
All changes align with the repository’s standards.



---

<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/256 **Author:** [@matthewhand](https://github.com/matthewhand) **Created:** 10/30/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feature-contrib-clean` --- ### 📝 Commits (2) - [`2ba806a`](https://github.com/open-webui/docs/commit/2ba806afa68523458937eeb11d1a53f91b996e94) feat: add contributing tutorial and gh-pages workflow - [`259b5f5`](https://github.com/open-webui/docs/commit/259b5f5ff1b2760afede03d15f8d6665c3d31859) Exclude GitHub Pages workflow from PR as it’s not in upstream ### 📊 Changes **2 files changed** (+84 additions, -55 deletions) <details> <summary>View changed files</summary> ➖ `.github/workflows/gh-pages.yml` (+0 -55) ➕ `docs/tutorials/tips/contributing-tutorial.md` (+84 -0) </details> ### 📄 Description ### **Pull Request Title:** Add Contributing Guidelines and Update GitHub Pages Workflow with Environment Variables --- ### **Description:** This pull request introduces two contributions: 1. **Contributing Guidelines:** - Adds a new file at `docs/tutorials/tips/contributing-tutorial.md`. - This document provides guidance for contributing code, reporting issues, improving documentation, and engaging with the community. 2. **GitHub Pages Workflow Update:** - Modifies the `.github/workflows/gh-pages.yml` to support **forked repositories** by introducing two new environment variables: - **`SITE_URL`**: Defines the custom site URL used for GitHub Pages deployment. - **`BASE_URL`**: Configures the base path for deployments. - These variables ensure forked repositories can use custom URLs for deployments without conflicts. --- ### **Files Added/Modified:** - **`docs/tutorials/tips/contributing-tutorial.md`** - Provides: - Community tutorial contribution practices and best practices. - **`.github/workflows/gh-pages.yml`** - Adds `SITE_URL` and `BASE_URL` environment variables to the deployment workflow to enable customized URLs for forked repositories. --- ### **Steps to Validate:** 1. **Review the Contributing Tutorial:** - Confirm the content in `docs/tutorials/tips/contributing-tutorial.md` is comprehensive and clear. - Ensure it aligns with the project's contribution policies and practices. 2. **Test the GitHub Pages Workflow:** - Add the **`SITE_URL`** and **`BASE_URL`** secrets to your forked repository. - Push changes to the `main` branch and confirm the deployment reflects the custom URLs. --- ### **Checklist:** - [x] Verified the content of the contributing tutorial. - [x] Confirmed the GitHub Pages workflow functions with the environment variables. - [x] All changes align with the repository’s standards. ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:11:30 +00:00