From dacf8996c4fa0221a83528007c14ccaf61370a62 Mon Sep 17 00:00:00 2001 From: Flook Peter Date: Fri, 14 Jun 2024 13:50:28 +0800 Subject: [PATCH] Add docs folder and mkdocs.yaml to top level folder to publish docs site --- .github/workflows/ci.yaml | 29 +++++++++++++++++++ .../docs => docs}/commands/connect.md | 0 .../docs => docs}/commands/list.md | 0 .../docs => docs}/commands/shutdown.md | 0 .../docs => docs}/commands/start.md | 0 .../docs => docs}/customization.md | 0 .../docs => docs}/getting-started.md | 0 {insta-infra-docs/docs => docs}/index.md | 0 {insta-infra-docs/docs => docs}/services.md | 1 + insta-infra-docs/mkdocs.yml => mkdocs.yml | 1 - 10 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yaml rename {insta-infra-docs/docs => docs}/commands/connect.md (100%) rename {insta-infra-docs/docs => docs}/commands/list.md (100%) rename {insta-infra-docs/docs => docs}/commands/shutdown.md (100%) rename {insta-infra-docs/docs => docs}/commands/start.md (100%) rename {insta-infra-docs/docs => docs}/customization.md (100%) rename {insta-infra-docs/docs => docs}/getting-started.md (100%) rename {insta-infra-docs/docs => docs}/index.md (100%) rename {insta-infra-docs/docs => docs}/services.md (95%) rename insta-infra-docs/mkdocs.yml => mkdocs.yml (99%) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..3ff578e --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,29 @@ +name: ci +on: + push: + branches: + - master + - 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 mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/insta-infra-docs/docs/commands/connect.md b/docs/commands/connect.md similarity index 100% rename from insta-infra-docs/docs/commands/connect.md rename to docs/commands/connect.md diff --git a/insta-infra-docs/docs/commands/list.md b/docs/commands/list.md similarity index 100% rename from insta-infra-docs/docs/commands/list.md rename to docs/commands/list.md diff --git a/insta-infra-docs/docs/commands/shutdown.md b/docs/commands/shutdown.md similarity index 100% rename from insta-infra-docs/docs/commands/shutdown.md rename to docs/commands/shutdown.md diff --git a/insta-infra-docs/docs/commands/start.md b/docs/commands/start.md similarity index 100% rename from insta-infra-docs/docs/commands/start.md rename to docs/commands/start.md diff --git a/insta-infra-docs/docs/customization.md b/docs/customization.md similarity index 100% rename from insta-infra-docs/docs/customization.md rename to docs/customization.md diff --git a/insta-infra-docs/docs/getting-started.md b/docs/getting-started.md similarity index 100% rename from insta-infra-docs/docs/getting-started.md rename to docs/getting-started.md diff --git a/insta-infra-docs/docs/index.md b/docs/index.md similarity index 100% rename from insta-infra-docs/docs/index.md rename to docs/index.md diff --git a/insta-infra-docs/docs/services.md b/docs/services.md similarity index 95% rename from insta-infra-docs/docs/services.md rename to docs/services.md index 7f18885..81f4b5b 100644 --- a/insta-infra-docs/docs/services.md +++ b/docs/services.md @@ -29,4 +29,5 @@ - rabbitmq - solace - trino +- unitycatalog - zookeeper diff --git a/insta-infra-docs/mkdocs.yml b/mkdocs.yml similarity index 99% rename from insta-infra-docs/mkdocs.yml rename to mkdocs.yml index 0d1edd7..b78d7c8 100644 --- a/insta-infra-docs/mkdocs.yml +++ b/mkdocs.yml @@ -11,4 +11,3 @@ nav: - List: commands/list.md - Customization: customization.md - Services: services.md -