Skip to content

Commit

Permalink
git workflow angepasst (#1)
Browse files Browse the repository at this point in the history
* git workflow angepasst

* update git-workflow

* Erweiterte Doku, GH-Pages
  • Loading branch information
hmt authored Apr 15, 2024
1 parent bd14a72 commit 8641b63
Show file tree
Hide file tree
Showing 9 changed files with 202 additions and 156 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci # or pnpm install / yarn install / bun install
- name: Build with VitePress
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: .vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
15 changes: 6 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
tmp
/bin/
/node_modules/
/.classpath
/.vitepress/dist
/.vitepress/cache
/dist/
/.project
/.settings
/.editorconfig
node_modules/
.vitepress/dist
.vitepress/cache
.project
.settings
.editorconfig
.DS_Store

# Ignore Gradle project-specific cache directory
Expand Down
95 changes: 0 additions & 95 deletions .vitepress/config.js

This file was deleted.

82 changes: 82 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import { defineConfig, loadEnv } from 'vite'

// https://vitepress.dev/reference/site-config
export default defineConfig(({ mode }) => {
const env = loadEnv(mode, process.cwd(), '');

return {
base: env.BASE || '/SVWS-Dokumentation/',
title: 'SVWS Dokumentation',
description: 'Dokumentation SVWS-Server NRW, Installation und Entwicklung',
lastUpdated: true,
themeConfig: {
lastUpdated: {
text: 'Diese Seite wurde zuletzt bearbeitet am',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium'
}
},
search: {
provider: 'local'
},
sidebar: {
'/': [
{ text: '', items: [
{ text: 'SVWS-Server', link: '/SVWS-Server/', collapsed: true, items: [
{ text: 'svws-core', link: '/SVWS-Server/svws-core/' },
{ text: 'svws-db', link: '/SVWS-Server/svws-db/' },
{ text: 'svws-db-utils', link: '/SVWS-Server/svws-db-utils/' },
{ text: 'svws-module-dav-api', link: '/SVWS-Server/svws-module-dav-api/' },
{ text: 'svws-openapi', link: '/SVWS-Server/svws-openapi/' },
{ text: 'svws-server-app', link: '/SVWS-Server/svws-server-app/' },
{ text: 'svws-transpile', link: '/SVWS-Server/svws-transpile/' },
{ text: 'svws-webclient', link: '/SVWS-Server/svws-webclient/' }
]
},
{ text: 'Deployment', link: '/Deployment/', collapsed: true, items: [
{ text: 'IT-Umgebungen', link: '/Deployment/IT-Umgebungen/' },
{ text: 'Linux-Installer', link: '/Deployment/Linux-Installer/' },
{ text: 'Docker-Container', link: '/Deployment/Docker/' },
{ text: 'Windows-Installer', link: '/Deployment/Windows-Installer/' },
{ text: 'Datenmigration', link: '/Deployment/Datenmigration/' },
{ text: 'Einrichtung', link: '/Deployment/Einrichtung/' }
]
},
{ text: 'Entwicklungsumgebungen', link: '/Entwicklungsumgebungen/', collapsed: true, items: [
{ text: 'Eclipse-Ubuntu', link: '/Entwicklungsumgebungen/Eclipse-Ubuntu/' },
{ text: 'Eclipse-Windows', link: '/Entwicklungsumgebungen/Eclipse-Windows/' },
{ text: 'IntelliJ', link: '/Entwicklungsumgebungen/IntelliJ/' },
{ text: 'macOS', link: '/Entwicklungsumgebungen/macOS/' },
{ text: 'VS-Code', link: '/Entwicklungsumgebungen/VS-Code/' }
]
},
{ text: 'Teamarbeit', link: '/Teamarbeit/', collapsed: true, items: [
{ text: 'Git Workflow', link: '/Teamarbeit/workflow/' },
{ text: 'Bugs & Issues melden', link: '/Teamarbeit/issues/' }
]
},
{ text: 'Schulungsumgebungen', link: '/Schulungsumgebungen/', collapsed: true, items: [
{ text: 'SchulungsClient', link: '/Schulungsumgebungen/SchulungsClient/' },
{ text: 'Virtualbox', link: '/Schulungsumgebungen/Virtualbox_Schulungsserver/' },
{ text: 'Bootstick', link: '/Schulungsumgebungen/Bootstick_Schulungsserver/' },
{ text: 'Proxmox', link: '/Schulungsumgebungen/Proxmox_Schulungsserver/' }
]
},
{ text: 'Projekte', link: '/Projekte/', collapsed: true, items: [
{ text: 'weblupo', link: '/Projekte/weblupo/' },
{ text: 'WeNoM', link: '/Projekte/WeNoM/' },
{ text: 'ASD-Statistik Modul', link: '/Projekte/ASD-Statistikmodul/' },
{ text: 'SchülerOnline', link: '/Projekte/SchülerOnline/' },
{ text: 'xSchule', link: '/Projekte/xSchule/' }

]
},
{ text: 'FAQs', link: '/FAQ/' }
]
}
]
}
}
}
})
Empty file.
12 changes: 6 additions & 6 deletions Teamarbeit/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Teamarbeit

Die Arbeit am SVWS Projekt findet seit November 2021 hauptsächlich in der eigenen GitHub-Organisation [github.com/SVWS-NRW/SVWS-Server](https://github.com/SVWS-NRW/SVWS-Server) statt.
Die Arbeit am SVWS Projekt findet in der GitHub-Organisation [github.com/SVWS-NRW/SVWS-Server](https://github.com/SVWS-NRW/SVWS-Server) statt.

## Organisationsstruktur

+ Projektleitung: Frank Pfotenhauer, MSB
+ Projektleitung: Frank Pfotenhauer, MSB

+ Technische Leitung: Thomas Bachran
+ Technische Leitung: Thomas Bachran

## Das Team

Das Entwicklerteam des SVWS-Servers setzt sich teilweise aus Lehrkräften zusammen, die für die Entwicklungsarbeit abgeordnet wurden.
Zusätzlich sind externe Entwicklerfirmen sowie Mitarbeiter des Ministeriums für Schule und Bildung am Projekt beteiligt.
Insgesamt sind etwa 20 Personen in die Entwicklung und das Projektmanagement des SVWS-Servers eingebunden. Das Team wird durch Fachberatungen für Schulen verstärkt, die insbesondere bei Testungen, Migrationsprozessen und dem Aufbau von Schulungsumgebungen unterstützen.
Das Entwicklerteam des SVWS-Servers setzt sich zum Teil aus Lehrkräften zusammen, die für die Entwicklungsarbeit abgeordnet wurden.
Zusätzlich sind externe Entwicklerfirmen sowie Mitarbeiter des Ministeriums für Schule und Bildung am Projekt beteiligt.
Insgesamt sind etwa 20 Personen in die Entwicklung und das Projektmanagement des SVWS-Servers eingebunden. Das Team wird durch Fachberatungen für Schulen verstärkt, die insbesondere bei Testungen, Migrationsprozessen und dem Aufbau von Schulungsumgebungen unterstützen.

## Mitarbeit

Expand Down
Binary file removed Teamarbeit/workflow/graphics/[Archivierte Dateien].url
Binary file not shown.
Loading

0 comments on commit 8641b63

Please sign in to comment.