diff --git a/.github/auto-merge.yml b/.github/auto-merge.yml deleted file mode 100644 index a1c3cc2119..0000000000 --- a/.github/auto-merge.yml +++ /dev/null @@ -1,12 +0,0 @@ -# Configuration for probot-auto-merge - https://github.com/bobvanderlinden/probot-auto-merge - -updateBranch: true -deleteBranchAfterMerge: true -reportStatus: true - -minApprovals: - COLLABORATOR: 2 -maxRequestedChanges: - NONE: 0 -blockingLabels: -- blocked \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000000..f421daaa26 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: weekly + open-pull-requests-limit: 10 + + - package-ecosystem: pip + directory: "/" + schedule: + interval: weekly + open-pull-requests-limit: 10 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000000..590c56578d --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,45 @@ +name: Build mkdocs and deploy to GitHub Pages + +on: [push, pull_request] + +jobs: + + build: + name: Build docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3.1.0 + - uses: actions/setup-python@v4.3.0 + with: + python-version: 3.x + - uses: actions/cache@v3.0.11 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install -r docs/requirements.txt + - run: | + cp -R general docs/ + cp -R images docs/ + - run: mkdocs build + + deploy: + if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main", "refs/heads/mkdocs"]'), github.ref) + needs: build + name: Deploy docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3.1.0 + with: + fetch-depth: '0' + - uses: actions/setup-python@v4.3.0 + with: + python-version: 3.x + - uses: actions/cache@v3.0.11 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install -r docs/requirements.txt + - run: | + cp -R general docs/ + cp -R images docs/ + - run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..bccd3dc6c2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.cache +site/ diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000000..6c1111da3f --- /dev/null +++ b/docs/.pages @@ -0,0 +1,6 @@ +nav: + - Introduction: index.md + - FAQ.md + - general + - images + - misc diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000000..df01f8f17d --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1 @@ +--8<-- "FAQ.md" diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..612c7a5e0d --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +--8<-- "README.md" diff --git a/docs/misc/finances.md b/docs/misc/finances.md new file mode 100644 index 0000000000..5f4b2f04af --- /dev/null +++ b/docs/misc/finances.md @@ -0,0 +1 @@ +--8<-- "finances.md" diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..f2aa392c19 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +mkdocs-awesome-pages-plugin==2.8.0 +mkdocs-material==8.5.10 +mkdocs-minify-plugin==0.6.1 +mkdocs-redirects==1.2.0 diff --git a/general/.pages b/general/.pages new file mode 100644 index 0000000000..d88d4486c8 --- /dev/null +++ b/general/.pages @@ -0,0 +1,12 @@ +nav: + - container-execution.md + - containers-101.md + - running-our-containers.md + - container-customization.md + - docker-compose.md + - understanding-puid-and-pgid.md + - updating-our-containers.md + - volumes.md + - fleet.md + - swag.md + - awesome-lsio.md diff --git a/images/.pages b/images/.pages new file mode 100644 index 0000000000..b3de8a52f2 --- /dev/null +++ b/images/.pages @@ -0,0 +1,2 @@ +nav: + - ... | regex=^docker-((?!(baseimage-|base-alpine-example|base-ubuntu-example|ci|doc-builder|gazee|gmail-order-bot|hydra2|jenkins-builder|letsencrypt|musicbrainz|mylar|pydio|readme-sync|rutorrent|sickrage|tester)).)*.md$ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000..b0d99be924 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,51 @@ +site_name: LinuxServer.io +site_url: https://docs.linuxserver.io +site_author: LinuxServer.io +site_description: Welcome to the home of the LinuxServer.io documentation! + +repo_name: linuxserver/docker-documentation +repo_url: https://github.com/linuxserver/docker-documentation +edit_uri: "" + +copyright: Copyright © 2022 LinuxServer.io + +theme: + name: material + language: en + features: + - navigation.instant + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: purple + accent: indigo + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: purple + accent: indigo + toggle: + icon: material/toggle-switch + name: Switch to light mode + favicon: https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media + logo: https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media + +markdown_extensions: + - pymdownx.snippets + +plugins: + - search + - awesome-pages + - minify: + minify_html: true + +extra: + social: + - icon: fontawesome/brands/square-github + link: https://github.com/linuxserver + - icon: fontawesome/brands/square-gitlab + link: https://gitlab.com/linuxserver.io + - icon: fontawesome/brands/square-twitter + link: https://twitter.com/linuxserverio