diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..096ede6 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,28 @@ +name: ci +on: + push: + branches: + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install -r requirements.txt + - run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2dc243b --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.venv +.cache +/site diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..6827fb7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ +# Welcome + +This documentation site describes what are all of the components the Beyond All +Reason (BAR) Infrastructure area, how they all connect to each other, and how we +would like to evolve the system in the future. + +BAR Infrastructure area contains all the software, configuration and resources +that support running of the [Beyond All Reason](https://github.com/beyond-all-reason/Beyond-All-Reason) +game on the [Recoil](https://github.com/beyond-all-reason/spring) engine, which +includes: lobby server, launcher, game files hosting, multiplayer game servers, +servers management, and more. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..1d127dc --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,13 @@ +site_name: BAR Infrastructure +site_url: https://beyond-all-reason.github.io/infrastructure +repo_url: https://github.com/beyond-all-reason/infrastracture +edit_uri: edit/main/docs/ +theme: + name: material + features: + - content.action.edit + - content.action.view +plugins: + - git-revision-date-localized: + enable_creation_date: true + - search diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d3e44bc --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +mkdocs~=1.6.0 +mkdocs-material~=9.5.31 +mkdocs-git-revision-date-localized-plugin~=1.2.6