About

This is the documentation repository of Websoft9 which is a Multi-application Self-hosted PaaS platform.

Contribute for it

It based on Docusaurus and you just need to edit markdown files for it.

DevOps workflow

• You can only add PR to dev branch, owner don't accept any PR for main branch

• Automation for dev

  Task/Stage	Submit PR	Merge PR
  Grammarly and Spell check	√
  Broken links check	√	√
  Checking for i18n file matches	√
  npm run	√

• Mannual actions for dev

  • build and deploy
  • create head files, applist files and other format file

• Automation for main

  • Broken links check
  • Build and publish

i18n

We only provide English and Chinese language support.

• English files: /i18n/docusaurus-plugin-content-docs/current
• Chinese files: /docs

If you want use tools for translation, we suggest you:

1. Use DeepL and Google Translate to translate at first.
2. Then use DeepL Write checking the results of translations.

CLI

# Install
yarn install

# Development 
npm run start -- --host 0.0.0.0  --port 3000
npm run start -- --host 0.0.0.0  --port 3000  --locale en

# Build
yarn build
npm run serve -- --host 0.0.0.0  --port 3000

# Create i18n language
yarn run write-translations -- --locale zh-cn

# Upgrade Docusaurus 
yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest