3ec85d7821
* docs: rework files structure * rewrite documentation entrypoint * update category files and use yml * add manuals entry page * update admin-manual titles and page order * create releases sections * move ssl configuration to reverse proxy * docs: update website vars and links * update release note codeblock syntax key * resurect troubleshooting guide * Update freeipa custom auth documentation * add notice about the state of the documentation * update the backup documentation * tmp: allow to deploy the website for preview * Don't use require.resolve for plugins * Update the main page link dest * update development environment title * rewrite the install/upgrade/migrate as guides * update website docs sections links * Fix urls * move release note to documentation * move home links to vars files * tmp: update deploy url * add react to tsconfig to handle jsx linting * fix: replace absolute url to relative path to files * tmp: allow CI Website dpeloy on working branch * Update release note title * use default syntax highlighting theme * update the troubleshooting guide * Wording * use CodeBlock components * Better prose * remove api_client config section * fix prose errors * update import prefix for vars file * reroder docs manuals links * use sentence capitalization for page titles * Wording * missing word * Update note about syslog log file * wording
67 lines
1.5 KiB
YAML
67 lines
1.5 KiB
YAML
name: Website
|
|
|
|
on:
|
|
push:
|
|
branches: [main, docs_update]
|
|
paths:
|
|
- .github/workflows/website.yml
|
|
- website/**
|
|
- docs/**
|
|
pull_request:
|
|
|
|
jobs:
|
|
lint:
|
|
name: Lint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Install Vale
|
|
run: |
|
|
sudo pip3 install gh-release-install
|
|
sudo gh-release-install \
|
|
errata-ai/vale \
|
|
vale_{version}_Linux_64-bit.tar.gz --extract vale \
|
|
/usr/local/bin/vale
|
|
|
|
- name: Add annotations matchers
|
|
run: |
|
|
echo "::add-matcher::.github/annotations/vale.json"
|
|
|
|
- name: Run Vale
|
|
run: |
|
|
make -C .github/vale/styles
|
|
vale --output line docs website/src/pages || true
|
|
|
|
deploy:
|
|
name: Deploy
|
|
runs-on: ubuntu-latest
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
|
|
needs: [lint]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v2
|
|
with:
|
|
node-version: "16"
|
|
cache: yarn
|
|
cache-dependency-path: ./website/yarn.lock
|
|
|
|
- name: Install
|
|
working-directory: website
|
|
run: yarn install --frozen-lockfile
|
|
|
|
- name: Build
|
|
working-directory: website
|
|
run: yarn build
|
|
|
|
- name: Deploy
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
if: ${{ github.ref == 'refs/heads/docs_update' }}
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./website/build
|