Skip to content

Commit

Permalink
add workflow for docs (#251)
Browse files Browse the repository at this point in the history
* add workflow for docs
  • Loading branch information
ChuckHend committed Jun 7, 2024
1 parent 41f953c commit d6f1c94
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Docs CI Workflow
on:
push:
branches:
- main
paths:
- "docs/**"
- ".github/workflows/docs.yml"
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v2
with:
python-version: 3.11
- run: curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.8.3 python3 -
- run: poetry install
- name: deploy docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: poetry run mkdocs gh-deploy --force
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Postgres 12-16.
- [Support](#support)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Updating](#updating)
- [Client Libraries](#client-libraries)
- [SQL Examples](#sql-examples)
- [Creating a queue](#creating-a-queue)
Expand All @@ -47,10 +48,10 @@ Postgres 12-16.

## Installation

The fastest way to get started is by running the Tembo docker image, where PGMQ comes pre-installed.
The fastest way to get started is by running the Tembo Docker image, where PGMQ comes pre-installed in Postgres.

```bash
docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pgmq-pg:latest
docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pg16-pgmq:latest
```

If you'd like to build from source, you can follow the instructions in [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down

0 comments on commit d6f1c94

Please sign in to comment.