Fix minor typographical issues in docs (#490) #109
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # ---------------------------------------------------------------------------- # | |
| # Apache 2.0 License Copyright © 2022-2023 The Aurae Authors # | |
| # # | |
| # +--------------------------------------------+ # | |
| # | █████╗ ██╗ ██╗██████╗ █████╗ ███████╗ | # | |
| # | ██╔══██╗██║ ██║██╔══██╗██╔══██╗██╔════╝ | # | |
| # | ███████║██║ ██║██████╔╝███████║█████╗ | # | |
| # | ██╔══██║██║ ██║██╔══██╗██╔══██║██╔══╝ | # | |
| # | ██║ ██║╚██████╔╝██║ ██║██║ ██║███████╗ | # | |
| # | ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝ | # | |
| # +--------------------------------------------+ # | |
| # # | |
| # Distributed Systems Runtime # | |
| # # | |
| # ---------------------------------------------------------------------------- # | |
| # # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); # | |
| # you may not use this file except in compliance with the License. # | |
| # You may obtain a copy of the License at # | |
| # # | |
| # http://www.apache.org/licenses/LICENSE-2.0 # | |
| # # | |
| # Unless required by applicable law or agreed to in writing, software # | |
| # distributed under the License is distributed on an "AS IS" BASIS, # | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # | |
| # See the License for the specific language governing permissions and # | |
| # limitations under the License. # | |
| # # | |
| # ---------------------------------------------------------------------------- # | |
| # | |
| # This will check the documentation, and deploy the https://aurae.io website | |
| # from the current code base upon merge -> main. | |
| # | |
| # This build check will introduce confidence for the following: | |
| # | |
| # - That the documentation is updated and passes our spelling checks. | |
| # - That the website is deployed with a fresh copy of the new docs. | |
| # | |
| # When this build passes we should have confidence that our documentation is | |
| # updated on the website complete with best practices. | |
| # | |
| name: "Deploy Website Documentation (291) [aurae:builder:tester-latest]" | |
| on: | |
| push: | |
| branches: main | |
| jobs: | |
| build-container: | |
| uses: ./.github/workflows/200-aurae-builder-image-docker-build-tester.yml | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build-container | |
| container: | |
| image: ghcr.io/${{ github.repository }}/aurae-builder:tester-latest | |
| credentials: | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| ## Configure Git | |
| # This fixes a current issue with git and dubious ownership of folders | |
| # https://github.com/actions/runner-images/issues/6775 | |
| - run: git config --global --add safe.directory /__w/aurae/aurae | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: 3.x | |
| - name: Install mkdocs-material [aurae-builder:builder-latest] | |
| run: | | |
| pip install mkdocs-material | |
| - name: Build Documentation [make docs] | |
| run: make docs | |
| - name: Deploy 'aurae.io' Website [mkdocs gh-deploy] | |
| run: mkdocs gh-deploy --force |