Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
65 changes: 65 additions & 0 deletions .github/workflows/userdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 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: [master, main, feat/user-docs]

# 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
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
cache-dependency-path: doc/user/package-lock.json
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci
working-directory: ./doc/user
- name: Build with VitePress
run: npm run docs:build
working-directory: ./doc/user
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/user/.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
2 changes: 2 additions & 0 deletions doc/user/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.vitepress/cache
.vitepress/dist
132 changes: 132 additions & 0 deletions doc/user/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Foodsoft",
description: "The ordersystem for Foodcooperatives",
base: "/foodsoft/",
ignoreDeadLinks: true,
locales: {
en: {
label: 'English',
lang: 'en',
link: '/en/',
themeConfig: {
nav: [
{ text: 'Documentation', items: [
{text: "Usage", link: '/en/documentation/usage' },
{text: "Admin", link: '/en/documentation/admin' },
{text: "Development", link: '/en/documentation/development' },
]},
],
sidebar: {
'/en/documentation/usage/': [
{
text: 'Usage',
items: [
{ text: 'Overview', link: '/en/documentation/usage' },
{ text: 'Getting Started and Navigation', link: '/en/documentation/usage/navigation' },
{ text: 'My Profile & Order Group', link: '/en/documentation/usage/profile-ordergroup' },
{ text: 'Communication', link: '/en/documentation/usage/communication' },
{ text: 'Information & Documents', link: '/en/documentation/usage/sharedocuments' }
]
}
],
'/en/documentation/admin/': [
{
text: 'Administration',
items: [
{ text: 'Overview', link: '/en/documentation/admin' },
{ text: 'General', link: '/en/documentation/admin/general' },
{ text: 'Suppliers & Articles', link: '/en/documentation/admin/suppliers' },
{ text: 'Orders', link: '/en/documentation/admin/orders' },
{ text: 'Storage', link: '/en/documentation/admin/storage' },
{ text: 'Finances', link: '/en/documentation/admin/finances' },
{ text: 'Users', link: '/en/documentation/admin/users' },
{ text: 'Settings', link: '/en/documentation/admin/settings' },
{ text: 'Database', link: '/en/documentation/admin/database' },
{ text: 'Demo Installations', link: '/en/documentation/admin/foodsoft-demo' },
{ text: 'Term Definitions', link: '/en/documentation/admin/terms-definitions' }
]
}
],
'/en/documentation/development/': [
{
text: 'Development',
items: [
{ text: 'Overview', link: '/en/documentation/development' },
{ text: 'First Steps', link: '/en/documentation/development/first-steps' }
]
}
]
}
}
},
root: {
label: 'Deutsch',
lang: 'de',
link: '/',
themeConfig: {
nav: [
{ text: 'Documentation', items: [
{text: "Usage", link: '/de/documentation/usage' },
{text: "Admin", link: '/de/documentation/admin' },
{text: "Development", link: '/de/documentation/development' },
]},
],
sidebar: {
'/de/documentation/usage/': [
{
text: 'Anwendung',
items: [
{ text: 'Überblick', link: '/de/documentation/usage' },
{ text: 'Starten und Navigieren', link: '/de/documentation/usage/navigation' },
{ text: 'Mein Profil & Bestellgruppe', link: '/de/documentation/usage/profile-ordergroup' },
{ text: 'Bestellungen', link: '/de/documentation/usage/order' },
{ text: 'Kommunikation', link: '/de/documentation/usage/communication' },
{ text: 'Aufgaben und Mitmachen', link: '/de/documentation/usage/tasks-cooperate' },
{ text: 'Informationen & Dokumente', link: '/de/documentation/usage/sharedocuments' }
]
}
],
'/de/documentation/admin/': [
{
text: 'Administration',
items: [
{ text: 'Überblick', link: '/de/documentation/admin' },
{ text: 'Allgemein', link: '/de/documentation/admin/general' },
{ text: 'Lieferantinnen & Artikel', link: '/de/documentation/admin/suppliers' },
{ text: 'Bestellungen', link: '/de/documentation/admin/orders' },
{ text: 'Lager', link: '/de/documentation/admin/storage' },
{ text: 'Finanzen', link: '/de/documentation/admin/finances' },
{ text: 'Benutzerinnen', link: '/de/documentation/admin/users' },
{ text: 'Einstellungen', link: '/de/documentation/admin/settings' },
{ text: 'Datenbank', link: '/de/documentation/admin/datenbank' }
]
}
],
'/de/documentation/development/': [
{
text: 'Entwicklung',
items: [
{ text: 'Überblick', link: '/de/documentation/development' },
{ text: 'Erste Schritte', link: '/de/documentation/development/first-steps' }
]
}
]
}
}
},
fr: { label: 'Français', lang: 'fr', link: '/fr/' },
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
lastUpdated: true,
editLink: {
pattern: 'https://github.com/foodcoops/foodsoft/edit/main/doc/user/:path'
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/foodcoops/foodsoft' }
]
}
})
5 changes: 5 additions & 0 deletions doc/user/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Foodsoft User Documentation

Uses [vitepress](https://vitepress.dev/) for static site generation

For a local dev environment run `npm docs:dev`
Binary file added doc/user/assets/fs-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions doc/user/de/archive/fs-admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Foodsoft Administration
description: Überblicksseite
published: true
date: 2021-10-02T16:45:31.425Z
tags:
editor: markdown
dateCreated: 2021-04-22T10:45:20.515Z
---

# Foodsoft Administration

Was die Foodosft alles kann, wobei und wie sie eure Foodcoop unterstützen kann, und wir ihr sie einrichten könnt. Auch im laufenden Betrieb der Foodcoop braucht die Foodsoft Administratorinnen, die sich im Hintergrund darum kümmern, dass es regelmäßig etwas zu Bestellen gibt, Artikel in der Foodsoft aktuell sind, und auch die Bestellungen abgrechnet werden.

- [Überblick](/de/documentation/admin/general)
- [Lieferantinnen, Artikel und Kategorien](/de/documentation/admin/suppliers)
- [Bestellungen](/de/documentation/admin/orders)
- [Lager](/de/documentation/admin/storage)
- [Finanzen](/de/documentation/admin/finances)
- [Benutzerinnen (Menü Administration)](/de/documentation/admin/users)
- [Einstellungen (Menü Administration)](/de/documentation/admin/settings)
{.links-list}
26 changes: 26 additions & 0 deletions doc/user/de/documentation/admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Administration
description: Dokumentation zur Administration der Foodsoft
published: true
date: 2023-04-24T18:56:55.736Z
tags:
editor: markdown
dateCreated: 2021-11-30T14:14:40.210Z
---

# Foodsoft Administration

Was die Foodosft alles kann, wobei und wie sie eure Foodcoop unterstützen kann, und wir ihr sie einrichten könnt. Auch im laufenden Betrieb der Foodcoop braucht die Foodsoft Administratorinnen, die sich im Hintergrund darum kümmern, dass es regelmäßig etwas zu Bestellen gibt, Artikel in der Foodsoft aktuell sind, und auch die Bestellungen abgrechnet werden.


- [Überblick](/de/documentation/admin/general)Funktionsüberblick, Navigation, technische Voraussetzungen, Installation und allgemeine Tipps
- [Lieferantinnen, Artikel und Kategorien](/de/documentation/admin/suppliers)Verwaltung von Lieferantinnen und Artikeln
- [Bestellungen](/de/documentation/admin/orders)Verwaltung von Bestellungen und Rechnungen
- [Lager](/de/documentation/admin/storage)Verwalten des Foodcoop-Lagers und Produktinventars
- [Finanzen](/de/documentation/admin/finances)Überblicksseite zu Finanzfunktionen sowie Verwendung
- [Benutzerinnen](/de/documentation/admin/users)Verwaltung aller Mitglieder, deren Foodsoft-Konten und Bestellgruppen
- [Einstellungen](/de/documentation/admin/settings)Erklärung zu globalen/administrativen Einstellungen der Foodsoft
- [Begriffserklärungen](/de/documentation/admin/terms-definitions)Definitionen und Bedeutungen von Begriffen in der Foodsoft
- [Häufige Fragen und Probleme](/de/documentation/admin/faq) Antworten und Lösungen für häufige Fragen und Probleme
- [Datenbank (phpMyAdmin)](/de/documentation/admin/datenbank) Änderungen vornehmen, für die es noch keine Benutzeroberfläche gibt, u.a. benutzerdefinierte Felder wie Mitgliedsbeitrag anlegen.
{.links-list}
Loading
Loading