From f58c9ed8d4b8fd59275097735612d9189ed8bbcb Mon Sep 17 00:00:00 2001 From: lgcorzo Date: Sat, 11 Apr 2026 22:41:44 +0200 Subject: [PATCH 1/2] chore: update workflows and synchronize wiki folder --- .github/workflows/docs-to-wiki.yml | 118 ++++++++++++++++++ {Documents => wiki}/Base_stories.md | 0 {Documents => wiki}/Configs_stories.md | 0 {Documents => wiki}/Datasets_stories.md | 0 {Documents => wiki}/Evaluations_stories.md | 0 {Documents => wiki}/Explanations_stories.md | 0 {Documents => wiki}/Inference_stories.md | 0 {Documents => wiki}/Metrics_stories.md | 0 {Documents => wiki}/Models_stories.md | 0 {Documents => wiki}/OSvariables_stories.md | 0 {Documents => wiki}/Promotions_stories.md | 0 {Documents => wiki}/Regristries_stories.md | 0 {Documents => wiki}/Schemas_stories.md | 0 {Documents => wiki}/Scripts_stories.md | 0 {Documents => wiki}/Searchers_stories.md | 0 {Documents => wiki}/Services_stories.md | 0 {Documents => wiki}/Settings_stories.md | 0 {Documents => wiki}/Signers_stories.md | 0 {Documents => wiki}/Splitters_stories.md | 0 {Documents => wiki}/Trainning_stories.md | 0 {Documents => wiki}/Tuning_stories.md | 0 .../backlog_mlops_regresion.md | 0 ...classes_regression_model_template.plantuml | 0 ...ackages_regression_model_template.plantuml | 0 24 files changed, 118 insertions(+) create mode 100644 .github/workflows/docs-to-wiki.yml rename {Documents => wiki}/Base_stories.md (100%) rename {Documents => wiki}/Configs_stories.md (100%) rename {Documents => wiki}/Datasets_stories.md (100%) rename {Documents => wiki}/Evaluations_stories.md (100%) rename {Documents => wiki}/Explanations_stories.md (100%) rename {Documents => wiki}/Inference_stories.md (100%) rename {Documents => wiki}/Metrics_stories.md (100%) rename {Documents => wiki}/Models_stories.md (100%) rename {Documents => wiki}/OSvariables_stories.md (100%) rename {Documents => wiki}/Promotions_stories.md (100%) rename {Documents => wiki}/Regristries_stories.md (100%) rename {Documents => wiki}/Schemas_stories.md (100%) rename {Documents => wiki}/Scripts_stories.md (100%) rename {Documents => wiki}/Searchers_stories.md (100%) rename {Documents => wiki}/Services_stories.md (100%) rename {Documents => wiki}/Settings_stories.md (100%) rename {Documents => wiki}/Signers_stories.md (100%) rename {Documents => wiki}/Splitters_stories.md (100%) rename {Documents => wiki}/Trainning_stories.md (100%) rename {Documents => wiki}/Tuning_stories.md (100%) rename {Documents => wiki}/backlog_mlops_regresion.md (100%) rename {Documents => wiki}/classes_regression_model_template.plantuml (100%) rename {Documents => wiki}/packages_regression_model_template.plantuml (100%) diff --git a/.github/workflows/docs-to-wiki.yml b/.github/workflows/docs-to-wiki.yml new file mode 100644 index 0000000..c404757 --- /dev/null +++ b/.github/workflows/docs-to-wiki.yml @@ -0,0 +1,118 @@ +name: Wiki Content Sync + +on: + push: + branches: + - main + paths: + - "wiki/**" + repository_dispatch: + types: [docs] + workflow_dispatch: + gollum: + +env: + GIT_AUTHOR_NAME: GitHub Action + GIT_AUTHOR_EMAIL: action@github.com + +permissions: + contents: write + pull-requests: write + +jobs: + sync-content-to-wiki: + if: always() && format('refs/heads/{0}', github.event.repository.default_branch) == github.ref && github.event_name != 'gollum' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Sync repo wiki folder to wiki + run: | + # 1. Prepare wiki repository URL + WIKI_URL="https://x-access-token:${{ secrets.WIKI_PERSONAL_ACCESS_TOKEN }}@github.com/${{ github.repository }}.wiki.git" + + # 2. Clone the wiki to a temporary directory + git clone "$WIKI_URL" wiki_temp + + # 3. Clean all files in wiki_temp (except .git) + find wiki_temp -mindepth 1 -maxdepth 1 -not -name ".git" -exec rm -rf {} + + + # 4. Copy everything from 'wiki/' folder to wiki_temp root + cp -r wiki/* wiki_temp/ + + # 5. Commit and push changes + cd wiki_temp + git config user.name "${{ env.GIT_AUTHOR_NAME }}" + git config user.email "${{ env.GIT_AUTHOR_EMAIL }}" + git add . + + if [ -n "$(git status --porcelain)" ]; then + git commit -m "chore: sync documentation to wiki [skip ci]" + # Targeting master as the wiki repo default for display + git push origin HEAD:master || git push origin HEAD:main + else + echo "No changes to sync." + fi + shell: bash + + sync-wiki-to-repo: + if: github.event_name == 'gollum' + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v4 + with: + token: ${{ secrets.WIKI_PERSONAL_ACCESS_TOKEN }} + ref: ${{ github.event.repository.default_branch }} + - name: Verify Wiki Directory + id: safe + run: | + if [ -d "wiki" ]; then + echo "Wiki directory found." + else + echo "wiki directory not found. Please sync to wiki first." + exit 1 + fi + shell: bash + - name: Sync Wiki to Repo + id: sync + run: | + # 1. Prepare wiki repository URL + WIKI_URL="https://x-access-token:${{ secrets.WIKI_PERSONAL_ACCESS_TOKEN }}@github.com/${{ github.repository }}.wiki.git" + + # 2. Clone the wiki + git clone "$WIKI_URL" wiki_temp + + # 3. Create a new branch for the changes + SYNC_BRANCH="wiki-sync-$(date +%s)" + git checkout -b "$SYNC_BRANCH" + + # 4. Sync contents from wiki_temp to the local wiki/ folder + rm -rf wiki/* + cp -r wiki_temp/* wiki/ + rm -rf wiki/.git + + # 5. Cleanup and Push the new branch + rm -rf wiki_temp + git config user.name "${{ env.GIT_AUTHOR_NAME }}" + git config user.email "${{ env.GIT_AUTHOR_EMAIL }}" + git add wiki/ + + if [ -n "$(git status --porcelain wiki/)" ]; then + git commit -m "chore: sync wiki changes back to repository" + git push origin "$SYNC_BRANCH" + echo "branch_name=$SYNC_BRANCH" >> $GITHUB_OUTPUT + else + echo "No changes found." + exit 0 + fi + shell: bash + - name: Create Pull Request + if: steps.sync.outputs.branch_name != '' + uses: repo-sync/pull-request@v2 + with: + source_branch: ${{ steps.sync.outputs.branch_name }} + destination_branch: ${{ github.event.repository.default_branch }} + pr_title: "[Chore] - Syncing Wiki changes from Web UI into repository" + pr_body: ":crown: *An automated PR* This PR syncs changes made directly in the GitHub Wiki back to the repository's `wiki/` folder." + pr_label: "wiki,automation" + github_token: ${{ secrets.WIKI_PERSONAL_ACCESS_TOKEN }} diff --git a/Documents/Base_stories.md b/wiki/Base_stories.md similarity index 100% rename from Documents/Base_stories.md rename to wiki/Base_stories.md diff --git a/Documents/Configs_stories.md b/wiki/Configs_stories.md similarity index 100% rename from Documents/Configs_stories.md rename to wiki/Configs_stories.md diff --git a/Documents/Datasets_stories.md b/wiki/Datasets_stories.md similarity index 100% rename from Documents/Datasets_stories.md rename to wiki/Datasets_stories.md diff --git a/Documents/Evaluations_stories.md b/wiki/Evaluations_stories.md similarity index 100% rename from Documents/Evaluations_stories.md rename to wiki/Evaluations_stories.md diff --git a/Documents/Explanations_stories.md b/wiki/Explanations_stories.md similarity index 100% rename from Documents/Explanations_stories.md rename to wiki/Explanations_stories.md diff --git a/Documents/Inference_stories.md b/wiki/Inference_stories.md similarity index 100% rename from Documents/Inference_stories.md rename to wiki/Inference_stories.md diff --git a/Documents/Metrics_stories.md b/wiki/Metrics_stories.md similarity index 100% rename from Documents/Metrics_stories.md rename to wiki/Metrics_stories.md diff --git a/Documents/Models_stories.md b/wiki/Models_stories.md similarity index 100% rename from Documents/Models_stories.md rename to wiki/Models_stories.md diff --git a/Documents/OSvariables_stories.md b/wiki/OSvariables_stories.md similarity index 100% rename from Documents/OSvariables_stories.md rename to wiki/OSvariables_stories.md diff --git a/Documents/Promotions_stories.md b/wiki/Promotions_stories.md similarity index 100% rename from Documents/Promotions_stories.md rename to wiki/Promotions_stories.md diff --git a/Documents/Regristries_stories.md b/wiki/Regristries_stories.md similarity index 100% rename from Documents/Regristries_stories.md rename to wiki/Regristries_stories.md diff --git a/Documents/Schemas_stories.md b/wiki/Schemas_stories.md similarity index 100% rename from Documents/Schemas_stories.md rename to wiki/Schemas_stories.md diff --git a/Documents/Scripts_stories.md b/wiki/Scripts_stories.md similarity index 100% rename from Documents/Scripts_stories.md rename to wiki/Scripts_stories.md diff --git a/Documents/Searchers_stories.md b/wiki/Searchers_stories.md similarity index 100% rename from Documents/Searchers_stories.md rename to wiki/Searchers_stories.md diff --git a/Documents/Services_stories.md b/wiki/Services_stories.md similarity index 100% rename from Documents/Services_stories.md rename to wiki/Services_stories.md diff --git a/Documents/Settings_stories.md b/wiki/Settings_stories.md similarity index 100% rename from Documents/Settings_stories.md rename to wiki/Settings_stories.md diff --git a/Documents/Signers_stories.md b/wiki/Signers_stories.md similarity index 100% rename from Documents/Signers_stories.md rename to wiki/Signers_stories.md diff --git a/Documents/Splitters_stories.md b/wiki/Splitters_stories.md similarity index 100% rename from Documents/Splitters_stories.md rename to wiki/Splitters_stories.md diff --git a/Documents/Trainning_stories.md b/wiki/Trainning_stories.md similarity index 100% rename from Documents/Trainning_stories.md rename to wiki/Trainning_stories.md diff --git a/Documents/Tuning_stories.md b/wiki/Tuning_stories.md similarity index 100% rename from Documents/Tuning_stories.md rename to wiki/Tuning_stories.md diff --git a/Documents/backlog_mlops_regresion.md b/wiki/backlog_mlops_regresion.md similarity index 100% rename from Documents/backlog_mlops_regresion.md rename to wiki/backlog_mlops_regresion.md diff --git a/Documents/classes_regression_model_template.plantuml b/wiki/classes_regression_model_template.plantuml similarity index 100% rename from Documents/classes_regression_model_template.plantuml rename to wiki/classes_regression_model_template.plantuml diff --git a/Documents/packages_regression_model_template.plantuml b/wiki/packages_regression_model_template.plantuml similarity index 100% rename from Documents/packages_regression_model_template.plantuml rename to wiki/packages_regression_model_template.plantuml From 3cf9134f8b1ce64adc7b233bf1266743db480942 Mon Sep 17 00:00:00 2001 From: lgcorzo Date: Sat, 11 Apr 2026 22:42:32 +0200 Subject: [PATCH 2/2] docs: add wiki sidebar navigation --- wiki/_Sidebar.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 wiki/_Sidebar.md diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md new file mode 100644 index 0000000..e33ae61 --- /dev/null +++ b/wiki/_Sidebar.md @@ -0,0 +1,37 @@ +# MLOps Python Package 📦 + +* [🏠 Home](Home) +* [📋 Backlog](backlog_mlops_regresion) + +## 🧠 Models & Data +* [Models](Models_stories) +* [Datasets](Datasets_stories) +* [Schemas](Schemas_stories) +* [Metrics](Metrics_stories) + +## 🚀 Lifecycle +* [Training](Trainning_stories) +* [Tuning](Tuning_stories) +* [Evaluations](Evaluations_stories) +* [Explanations](Explanations_stories) +* [Inference](Inference_stories) +* [Promotions](Promotions_stories) + +## 🛠️ Config & Tools +* [Configs](Configs_stories) +* [Settings](Settings_stories) +* [OS Variables](OSvariables_stories) +* [Scripts](Scripts_stories) + +## 🏛️ Registry & Services +* [Registries](Regristries_stories) +* [Services](Services_stories) +* [Signers](Signers_stories) + +## 🔧 Components +* [Base](Base_stories) +* [Searchers](Searchers_stories) +* [Splitters](Splitters_stories) + +--- +*Powered by MLOps Factory*