Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/article_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Article Request
description: Let us know about articles and sections you would like to see
labels: ["style: article/section 📝"]
body:
- type: markdown
attributes:
value: |
Thank you for taking time to fill out this report!
- type: textarea
id: description
attributes:
label: What would you like to see added?
description:
Please tell us about what article or section you think is missing.
Please include images and links as appropriate, and tell us where you
think the new content would best fit.
placeholder: Tell us what you would like to see!
validations:
required: true
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: Let us know about bugs!
labels: ["fix: bug 🐞"]
body:
- type: markdown
attributes:
value: |
Thank you for taking time to fill out this report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description:
Please describe what happened. Screenshots and URLs of affected parts
are welcome.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: what-should-happen
attributes:
label: What should happen instead?
description: Please describe what should have happened.
placeholder: Tell us what you see!
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: dropdown
id: devices
attributes:
label: What devices are you seeing the problem on?
multiple: true
options:
- Windows
- MacOS
- Linux
- Android
- iOS
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/inaccuracy_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Inaccuracy Report
description: Let us know about inaccurate or outdated information
labels: ["fix: inaccuracy ⚠️"]
body:
- type: markdown
attributes:
value: |
Thank you for taking time to fill out this report!
- type: textarea
id: description
attributes:
label: What is inaccurate?
description: Please describe the inaccuracy. If you can, please tell us what would be an accurate replacement.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: url
attributes:
label: Where is the inaccuracy?
description: Please paste a link to the affected section.
placeholder: Tell us where it is!
validations:
required: true
43 changes: 43 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Pull Request

## Intent
<!-- Describe the intent of the changes. -->

## Proposed Changes
<!-- Provide specific details of what is changing. -->

### Changes to Section Headers
<!-- Write down which headers have changed.
old-header -> new-header
-->

### Changes to Page URLs
<!-- Write down which pages have changed.
old/page.md -> new/page.md
-->

## Related or Fixed Issues
<!-- Examples:
Fixes #123
Related to #101
-->

## Accessibility Checklist

I have ensured all of the following for new or changed content:

- [ ] all images have appropriate alt text. [Guidelines](https://www.wcag.com/blog/good-alt-text-bad-alt-text-making-your-content-perceivable/)
- [ ] all images with text have sufficient contrast ratio. [Checker](https://webaim.org/resources/contrastchecker/)
- [ ] all image text is transcribed or described in body text.
- [ ] all technical terms, jargon, and abbreviations are introduced before they are used.

## Style Checklist

I have done all of the following:

- [ ] searched for other relevant pages and crosslinked from my content to them.
- [ ] searched for other relevant pages and crosslinked from them to my content.
- [ ] added redirects in `mkdocs.yml` for any moved headers or pages.
- [ ] defined new technical terms, jargon, and abbreviations in the glossary.
- [ ] searched for existing technical terms, jargon, and abbreviations in the glossary and added crosslinks to them.
- [ ] properly formatted and introduced key branding terms. [List here](https://docs.rc.uab.edu/contributing/contributor_guide#terminology).
17 changes: 17 additions & 0 deletions .github/shared/build_docs_pages/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# builds mkdocs, reusable by other checks

name: Build Docs Pages
description: Build Docs Pages for mkdocs workflows.

runs:
using: composite
steps:
- uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # 3.2.0
with:
environment-file: build_env.yml
activate-environment: mkdocs
miniforge-version: latest

- name: Build Pages # this is both a build and check step
run: mkdocs build --strict
shell: bash -l {0} # must have -l because conda requires login shell to function in subsequent steps
30 changes: 30 additions & 0 deletions .github/workflows/check_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# checks for mkdocs specific issues

name: docs

on: # yamllint disable-line rule:truthy
pull_request:
branches:
- main
paths:
- "build_env.yml"
- "mkdocs.yml"
- "build_scripts/**"
- "docs/**"
workflow_dispatch:

jobs:
check_markdown:
uses: "./.github/workflows/reusable_check_markdown.yml"
with:
globs: "docs/**/*.md"
check_docs:
needs: check_markdown
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
with:
fetch-depth: 0 # mkdocs-git-revision-date-localized-plugin
- uses: "./.github/shared/build_docs_pages/"
31 changes: 31 additions & 0 deletions .github/workflows/check_python.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# checks python files for python linting and formatting issues

name: python

on: # yamllint disable-line rule:truthy
push:
branches:
- main
paths:
- "**.py"
pull_request:
branches:
- main
paths:
- "**.py"
workflow_dispatch:

jobs:
check_python:
runs-on: ubuntu-latest
permissions:
contents: read
strategy:
matrix:
args: ["check", "format --check --diff"]
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
- uses: astral-sh/ruff-action@eaf0ecdd668ceea36159ff9d91882c9795d89b49 # 3.4.0
with:
args: ${{ matrix.args }}
version: 0.12.0
31 changes: 31 additions & 0 deletions .github/workflows/check_yaml.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# checks yaml for yaml-specific linting and formatting issues

name: yaml

on: # yamllint disable-line rule:truthy
push:
branches:
- main
paths:
- "**.yml"
- "**.yaml"
pull_request:
branches:
- main
paths:
- "**.yml"
- "**.yaml"
workflow_dispatch:

jobs:
check_yaml:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
- uses: karancode/yamllint-github-action@4052d365f09b8d34eb552c363d1141fd60e2aeb2 # 3.0.0
with:
yamllint_config_filepath: ".yamllint.yaml"
yamllint_strict: true
yamllint_comment: true
31 changes: 0 additions & 31 deletions .github/workflows/ci.yml

This file was deleted.

40 changes: 40 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# deploys documentation to gh-pages

name: docs

on: # yamllint disable-line rule:truthy
push:
branches:
- main
paths:
- "build_env.yml"
- "mkdocs.yml"
- "build_scripts/**"
- "docs/**"
workflow_dispatch:

jobs:
check_markdown:
uses: "./.github/workflows/reusable_check_markdown.yml"
with:
globs: "docs/**/*.md"
deploy_docs:
needs: check_markdown
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
with:
fetch-depth: 0 # mkdocs-git-revision-date-localized-plugin
- uses: "./.github/shared/build_docs_pages/"
- uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # 5.0.0
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # 3.0.1
with:
path: "./site"
- uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # 4.0.5
56 changes: 56 additions & 0 deletions .github/workflows/reusable_check_markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# checks markdown files for markdown specific linting and formatting issues
# reusable by other checks

name: markdown

on: # yamllint disable-line rule:truthy
push:
branches:
- main
paths:
- "**.md"
- "!docs/**" # covered by check_docs.yml
pull_request:
branches:
- main
paths:
- "**.md"
- "!docs/**" # covered by check_docs.yml
workflow_dispatch:
workflow_call:
inputs:
globs:
type: string

jobs:
check_markdown:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
- name: Configure Globs
id: globs
run: |
if [ -n "${{ inputs.globs }}" ]; then
GLOBS_STRING="${{ inputs.globs }}"
else
GLOBS_STRING='**/*.md !docs/**/*.md'
fi

IFS=' ' read -r -a GLOBS_ARRAY <<< "$GLOBS_STRING"
NEWLINE_DELIMITED_GLOBS=""
for glob in "${GLOBS_ARRAY[@]}"; do
if [ -n "$NEWLINE_DELIMITED_GLOBS" ]; then
NEWLINE_DELIMITED_GLOBS+=$'\n'
fi
NEWLINE_DELIMITED_GLOBS+="$glob"
done

echo "globs<<EOF" >> "$GITHUB_OUTPUT"
echo "$NEWLINE_DELIMITED_GLOBS" >> "$GITHUB_OUTPUT"
echo "EOF" >> "$GITHUB_OUTPUT"
- uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # 20.0.0
with:
config: ".markdownlint-cli2.jsonc"
globs: "${{ steps.globs.outputs.globs }}"
Loading
Loading