Skip to content

Commit

Permalink
feat: Document Liquid template functions (#306)
Browse files Browse the repository at this point in the history
* add action

* add make target

* download docs

* add menu entry

* update old doc

* format

* pull docs
  • Loading branch information
maciaszczykm authored Sep 24, 2024
1 parent bb17dc3 commit 01e434b
Show file tree
Hide file tree
Showing 8 changed files with 2,947 additions and 40 deletions.
25 changes: 22 additions & 3 deletions .github/workflows/cron.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Refresh Operator Docs
name: Refresh Docs
on:
schedule:
- cron: '0 0 * * *'

jobs:
gendocs:
operator-docs:
runs-on: ubuntu-latest
permissions:
contents: 'write'
Expand All @@ -25,4 +25,23 @@ jobs:
commit-message: Update docs for operator
branch: docs-${{steps.date.outputs.date}}
labels: release
base: main
base: main
liquid-docs:
runs-on: ubuntu-latest
permissions:
contents: 'write'
id-token: 'write'
pull-requests: 'write'
steps:
- uses: actions/checkout@v3
- run: make liquid-docs
- id: date
run: echo "date=$(date +%Y%m%d%H%M%S)" >> $GITHUB_OUTPUT
- uses: peter-evans/create-pull-request@v5
with:
title: "docs: Update supported Liquid filters docs"
body: Automated pull request to regenerate supported Liquid filters docs.
commit-message: update supported Liquid filters docs
branch: docs-${{steps.date.outputs.date}}
labels: enhancement
base: main
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,7 @@ web: ## runs the docs site locally
yarn dev

crd-docs:
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/deployments/operator/api.md
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/deployments/operator/api.md

liquid-docs:
curl -L https://raw.githubusercontent.com/pluralsh/polly/main/docs/liquid-filters.md --output pages/deployments/templating-filters.md
Loading

0 comments on commit 01e434b

Please sign in to comment.