diff --git a/.github/workflows/deploy-github-pages.yml b/.github/workflows/deploy-github-pages.yml new file mode 100644 index 0000000..84baf75 --- /dev/null +++ b/.github/workflows/deploy-github-pages.yml @@ -0,0 +1,71 @@ +name: Deploy Hugo site to Pages + +on: + push: + branches: ["main"] + paths: + - 'docs/**' + workflow_dispatch: + +permissions: {} + +concurrency: + group: "pages" + cancel-in-progress: false + +defaults: + run: + shell: bash + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + env: + HUGO_VERSION: 0.124.1 + steps: + - name: Install Hugo CLI + run: | + wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ + && sudo dpkg -i ${{ runner.temp }}/hugo.deb + - name: Install Dart Sass + run: sudo snap install dart-sass + - name: Checkout + uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + with: + submodules: recursive + - name: Setup Pages + id: pages + uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 + - name: Install Node.js dependencies + working-directory: ./docs + run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" + - name: Build with Hugo + working-directory: ./docs + env: + HUGO_ENVIRONMENT: production + HUGO_ENV: production + run: | + hugo \ + --minify \ + --baseURL "${{ steps.pages.outputs.base_url }}/" + - name: Upload artifact + uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 + with: + path: ./docs/public + + deploy: + runs-on: ubuntu-latest + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + contents: read + pages: write + id-token: write + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..c28483c --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +public/** diff --git a/docs/.hugo_build.lock b/docs/.hugo_build.lock new file mode 100644 index 0000000..e69de29 diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md new file mode 100644 index 0000000..c6f3fce --- /dev/null +++ b/docs/archetypes/default.md @@ -0,0 +1,5 @@ ++++ +title = '{{ replace .File.ContentBaseName "-" " " | title }}' +date = {{ .Date }} +draft = true ++++ diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 0000000..6d0797c --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1,5 @@ +--- +title: "poutine" +--- + +This is the documentation for the [poutine](https://github.com/boostsecurityio/poutine) project. \ No newline at end of file diff --git a/docs/content/en/rules/debug_enabled.md b/docs/content/en/rules/debug_enabled.md index 9c5b455..6ffdb0c 100644 --- a/docs/content/en/rules/debug_enabled.md +++ b/docs/content/en/rules/debug_enabled.md @@ -70,5 +70,6 @@ job_name: ``` ## See Also + - https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging - https://docs.gitlab.com/ee/ci/variables/index.html#enable-debug-logging - https://docs.gitlab.com/ee/ci/variables/index.html#mask-a-cicd-variable diff --git a/docs/data/menu/extra.yaml b/docs/data/menu/extra.yaml new file mode 100644 index 0000000..e7b673d --- /dev/null +++ b/docs/data/menu/extra.yaml @@ -0,0 +1,6 @@ +--- +header: + - name: GitHub + ref: https://github.com/boostsecurityio/poutine + icon: gdoc_github + external: true \ No newline at end of file diff --git a/docs/data/menu/more.yaml b/docs/data/menu/more.yaml new file mode 100644 index 0000000..12a692c --- /dev/null +++ b/docs/data/menu/more.yaml @@ -0,0 +1,11 @@ +--- +more: + - name: Releases + ref: "https://github.com/boostsecurityio/poutine/releases" + external: true + icon: "gdoc_download" + - name: GitHub + ref: "https://github.com/boostsecurityio/poutine" + external: true + icon: "gdoc_github" + \ No newline at end of file diff --git a/docs/hugo.toml b/docs/hugo.toml new file mode 100644 index 0000000..c6ad846 --- /dev/null +++ b/docs/hugo.toml @@ -0,0 +1,30 @@ +baseURL = 'https://boostsecurityio.github.io/poutine/' +languageCode = 'en-us' +title = 'poutine' +theme = "hugo-geekdoc" + +pluralizeListTitles = false + +# Geekdoc required configuration +#pygmentsUseClasses = true +pygmentsUseClasses = false +pygmentsCodeFences = true +disablePathToLower = true +# geekdocFileTreeSortBy = "linkTitle" + +# Required if you want to render robots.txt template +enableRobotsTXT = true + +# Needed for mermaid shortcodes +[markup] + [markup.goldmark.renderer] + # Needed for mermaid shortcode + unsafe = true + [markup.tableOfContents] + startLevel = 1 + endLevel = 9 + [markup.highlight] + style = 'solarized-dark' + +[taxonomies] + tag = "tags" \ No newline at end of file diff --git a/docs/static/brand.svg b/docs/static/brand.svg new file mode 100644 index 0000000..506ddd2 --- /dev/null +++ b/docs/static/brand.svg @@ -0,0 +1,1719 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/static/custom.css b/docs/static/custom.css new file mode 100644 index 0000000..84e9dfd --- /dev/null +++ b/docs/static/custom.css @@ -0,0 +1,39 @@ +/* + * Didn't find much time to create a theme yet, + * so there are just a few non-default settings for now. + */ + :root, + :root[color-theme="light"] { + --header-background: #222222; + --footer-background: #e6522c; + --footer-link-color: #ffffff; + --footer-link-color-visited: #ffffff; + } + + @media (prefers-color-scheme: light) { + :root { + --header-background: #222222; + --footer-background: #e6522c; + --footer-link-color: #ffffff; + --footer-link-color-visited: #ffffff; + } + } + + :root[color-theme="dark"] + { + --header-background: #111c24; + --body-background: #1f1f21; + --footer-background: #e6522c; + --footer-link-color: #ffffff; + --footer-link-color-visited: #ffffff; + } + + @media (prefers-color-scheme: dark) { + :root { + --header-background: #111c24; + --body-background: #1f1f21; + --footer-background: #e6522c; + --footer-link-color: #ffffff; + --footer-link-color-visited: #ffffff; + } + } \ No newline at end of file diff --git a/docs/static/favicon/favicon.svg b/docs/static/favicon/favicon.svg new file mode 100644 index 0000000..506ddd2 --- /dev/null +++ b/docs/static/favicon/favicon.svg @@ -0,0 +1,1719 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +