From ee5aaf65859672dfdd8eb8d463794e443756ea26 Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Wed, 7 Dec 2022 14:18:16 -0800 Subject: [PATCH 01/20] Add basic material theme config. --- .readthedocs.yaml | 20 +++++++++++++++ lint/Dockerfile | 22 ++++++++-------- lint/requirements.in | 1 + lint/requirements.txt | 59 +++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 12 +-------- requirements.txt | 1 - 6 files changed, 93 insertions(+), 22 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 lint/requirements.in create mode 100644 lint/requirements.txt delete mode 100644 requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..6818cc941e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: lint/requirements.txt diff --git a/lint/Dockerfile b/lint/Dockerfile index e36ff9536f..26d3efdd7f 100644 --- a/lint/Dockerfile +++ b/lint/Dockerfile @@ -2,17 +2,19 @@ FROM node:16-alpine ENV REVIEWDOG_VERSION=v0.13.1 +COPY requirements.txt /usr/src/ + RUN \ - apk add --update \ - ca-certificates \ - bash \ - git \ - openssh \ - python3 \ - python3-dev \ - py3-pip \ - build-base && \ - pip3 install mkdocs mdx_truly_sane_lists + apk add --update \ + ca-certificates \ + bash \ + git \ + openssh \ + python3 \ + python3-dev \ + py3-pip \ + build-base && \ + pip3 install -r /usr/src/requirements.txt SHELL ["/bin/bash", "-o", "pipefail", "-c"] RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b /usr/local/bin/ ${REVIEWDOG_VERSION} diff --git a/lint/requirements.in b/lint/requirements.in new file mode 100644 index 0000000000..9171172747 --- /dev/null +++ b/lint/requirements.in @@ -0,0 +1 @@ +mkdocs_material==8.5.11 diff --git a/lint/requirements.txt b/lint/requirements.txt new file mode 100644 index 0000000000..1c526d1d59 --- /dev/null +++ b/lint/requirements.txt @@ -0,0 +1,59 @@ +# +# This file is autogenerated by pip-compile with python 3.10 +# To update, run: +# +# pip-compile requirements.in +# +certifi==2022.12.7 + # via requests +charset-normalizer==2.1.1 + # via requests +click==8.1.3 + # via mkdocs +ghp-import==2.1.0 + # via mkdocs +idna==3.4 + # via requests +jinja2==3.1.2 + # via + # mkdocs + # mkdocs-material +markdown==3.3.7 + # via + # mkdocs + # mkdocs-material + # pymdown-extensions +markupsafe==2.1.1 + # via jinja2 +mergedeep==1.3.4 + # via mkdocs +mkdocs==1.4.2 + # via mkdocs-material +mkdocs-material==8.5.11 + # via -r requirements.in +mkdocs-material-extensions==1.1.1 + # via mkdocs-material +packaging==21.3 + # via mkdocs +pygments==2.13.0 + # via mkdocs-material +pymdown-extensions==9.9 + # via mkdocs-material +pyparsing==3.0.9 + # via packaging +python-dateutil==2.8.2 + # via ghp-import +pyyaml==6.0 + # via + # mkdocs + # pyyaml-env-tag +pyyaml-env-tag==0.1 + # via mkdocs +requests==2.28.1 + # via mkdocs-material +six==1.16.0 + # via python-dateutil +urllib3==1.26.13 + # via requests +watchdog==2.2.0 + # via mkdocs diff --git a/mkdocs.yml b/mkdocs.yml index 751ed34536..6e59275ccd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,16 +2,6 @@ site_name: CivicActions Handbook repo_url: https://github.com/CivicActions/handbook/ site_url: https://handbook.civicactions.com/en/latest/ theme: - name: readthedocs - highlightjs: true - hljs_languages: - - yaml - - rust + name: material plugins: - search -extra_css: - - css/extra.css -extra_javascript: - - js/extra.js -markdown_extensions: - - mdx_truly_sane_lists diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 65f7594229..0000000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -mdx_truly_sane_lists==1.2 From 66985a5409daa10535613c2eb5c0d7bcb2160f1b Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Wed, 7 Dec 2022 16:22:03 -0800 Subject: [PATCH 02/20] Switch workflow to use lint action, rather than latest container. --- .github/workflows/mkdocs.yml | 12 +++++++----- lint/action.yml | 5 ++++- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 00cbeb77ae..44d0c60115 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -8,9 +8,11 @@ jobs: mkdocs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Run mkdocs - uses: docker://civicactions/handbook-lint:latest + - uses: actions/checkout@v1 with: - entrypoint: /bin/bash - args: mkdocs.sh + fetch-depth: 0 + - name: Run remark-lint with reviewdog for documentation projects. + uses: ./lint + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + command: mkdocs.sh \ No newline at end of file diff --git a/lint/action.yml b/lint/action.yml index 3a5e09562b..1bd22e4882 100644 --- a/lint/action.yml +++ b/lint/action.yml @@ -6,8 +6,11 @@ inputs: description: "GITHUB_TOKEN." required: true default: ${{ github.token }} + command: + description: "Command to run" + required: true runs: using: "docker" image: "Dockerfile" args: - - remark.sh + - ${{ inputs.command }} From b1a2ab97b37368d1fe1b799a04f5233f2c179ea0 Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Wed, 7 Dec 2022 16:26:57 -0800 Subject: [PATCH 03/20] Update check name and add log message. --- .github/workflows/mkdocs.yml | 2 +- lint/mkdocs.sh | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 44d0c60115..c0e7a182ae 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -11,7 +11,7 @@ jobs: - uses: actions/checkout@v1 with: fetch-depth: 0 - - name: Run remark-lint with reviewdog for documentation projects. + - name: Run mkdocs to check build. uses: ./lint with: github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/lint/mkdocs.sh b/lint/mkdocs.sh index 33c58c9a18..a9a473003f 100644 --- a/lint/mkdocs.sh +++ b/lint/mkdocs.sh @@ -7,3 +7,4 @@ set -euo pipefail tmp_dir=$(mktemp -d -t mkdocs-XXXXXX) /usr/bin/mkdocs build --strict --site-dir "${tmp_dir}" 2>&1 | { grep -v '^INFO' || true; } rm -rf "${tmp_dir}" +echo "mkdocs build successful" From 33341e6b295199ddc34af408752d3d1a42ce1ee6 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 8 Dec 2022 00:30:29 +0000 Subject: [PATCH 04/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/workflows/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index c0e7a182ae..c89fe911a8 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -15,4 +15,4 @@ jobs: uses: ./lint with: github_token: ${{ secrets.GITHUB_TOKEN }} - command: mkdocs.sh \ No newline at end of file + command: mkdocs.sh From 2542fc7c4afd091b50af22ac3c2a20805f5ac31c Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Wed, 7 Dec 2022 16:34:28 -0800 Subject: [PATCH 05/20] Add missing remark command. --- .github/workflows/reviewdog.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml index 90a103a789..0a6b2d8108 100644 --- a/.github/workflows/reviewdog.yml +++ b/.github/workflows/reviewdog.yml @@ -14,3 +14,4 @@ jobs: uses: ./lint with: github_token: ${{ secrets.GITHUB_TOKEN }} + command: remark.sh From 07d2a69a24f731546d1012a355de43a3841a0a62 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Tue, 13 Dec 2022 10:57:52 -0800 Subject: [PATCH 06/20] Setting the navigation features for tabs and expansion. --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 6e59275ccd..02e8230c14 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,5 +3,8 @@ repo_url: https://github.com/CivicActions/handbook/ site_url: https://handbook.civicactions.com/en/latest/ theme: name: material + features: + - navigation.tabs + - navigation.expand plugins: - search From f6f745a800891e40f27614984790ca569bc68eb3 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Mon, 19 Dec 2022 09:08:43 -0800 Subject: [PATCH 07/20] Switching handbook to guidebook. Adjusting styles (#963) * Switching handbook to guidebook. Adding back custom CSS to set new color styles. Adjusted TOC and added favicon. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Added light and dark mode toggle with CSS to go with it. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Ignoring linting for CSS line. * Trying to disabling linting. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removed lint disable code. * Exclude CSS from remark lint. Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/css/extra.css | 68 ++++++---------------------------------------- docs/index.md | 6 ++-- lint/remark.sh | 4 +-- mkdocs.yml | 19 ++++++++++++- 4 files changed, 31 insertions(+), 66 deletions(-) diff --git a/docs/css/extra.css b/docs/css/extra.css index abeaafdd99..7df01a699b 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -1,63 +1,11 @@ -h1, -h2, -h3, -h4, -h5, -h6, -p, -li, -blockquote { - font-family: "Ubuntu", sans-serif; +:root { + --md-primary-fg-color: #a23737; + --md-accent-fg-color: #3b4eb7; } -h1, -h2, -h3, -h4, -h5, -h6 { - font-weight: 900; +[data-md-color-scheme="slate"] { + --md-typeset-a-color: #ffa8a8; + --md-accent-fg-color: #afbbff; } -.wy-nav-side { - background: #002f43; -} -.wy-nav-content { - color: #002f43; -} -.wy-nav-content a, -.wy-nav-content a:visited { - color: #db1b3b; -} -.wy-menu-vertical ul.subnav li.current span { - color: #484849; -} -.wy-menu-vertical span { - color: #edf0f2; - font-weight: bold; -} -.wy-menu-vertical a:active { - background-color: #db1b3b; -} -.wy-menu-vertical a:hover { - color: #e7e7e7; -} -.wy-menu-vertical li.current a { - color: #404040; -} -.wy-side-nav-search { - background-color: #db1b3b; -} -.wy-side-nav-search > div.version { - color: #fff7f6; -} -code { - color: #9d3429; -} -a code { - color: #1e5d86; -} -a:hover code { - color: #1f5d86; -} -footer { - color: #545454; +.md-search__form { + background-color: #d83933; } diff --git a/docs/index.md b/docs/index.md index 3a97d5aedf..ba6becc0b2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# CivicActions Handbook +# CivicActions Guidebook [![Documentation Status](https://readthedocs.org/projects/civicactions-handbook/badge/?version=latest)](https://handbook.civicactions.com/en/latest/?badge=latest) @@ -11,9 +11,9 @@ Lafayette, CA 94549 888.714.7388 | fax civicactions.com -### Handbook Purpose +### Guidebook Purpose -This Handbook has been prepared to describe the CivicActions philosophy, working methods and processes, employment practices, policies, benefits, and conduct we expect from members of our team. +This Guidebook has been prepared to describe the CivicActions philosophy, working methods and processes, employment practices, policies, benefits, and conduct we expect from members of our team. ## License diff --git a/lint/remark.sh b/lint/remark.sh index 7de8a6be37..3fa57566b2 100755 --- a/lint/remark.sh +++ b/lint/remark.sh @@ -12,8 +12,8 @@ MASTER=master if [[ -z ${LOCAL_MASTER} ]]; then MASTER=origin/master fi -# Only check paths changed on branch to avoid excessive output. -export REMARK_PATHS=$(git diff --diff-filter=AM --name-only "${MASTER}" | grep '^docs') +# Only check paths changed on branch to avoid excessive output. Exclude CSS. +export REMARK_PATHS=$(git diff --diff-filter=AM --name-only "${MASTER}" ':!docs/css/extra.css' | grep '^docs') if [[ -n "${INPUT_GITHUB_TOKEN:-}" ]]; then export REVIEWDOG_GITHUB_API_TOKEN="${INPUT_GITHUB_TOKEN}" diff --git a/mkdocs.yml b/mkdocs.yml index 02e8230c14..0eae002371 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: CivicActions Handbook +site_name: CivicActions Guidebook - Beta repo_url: https://github.com/CivicActions/handbook/ site_url: https://handbook.civicactions.com/en/latest/ theme: @@ -6,5 +6,22 @@ theme: features: - navigation.tabs - navigation.expand + favicon: img/favicon.ico + palette: + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode +markdown_extensions: + - toc: + title: On this page plugins: - search +extra_css: + - css/extra.css From 5f71b1f59cf64076074192ef6cc6a45645ede9a2 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Mon, 19 Dec 2022 15:02:25 -0800 Subject: [PATCH 08/20] Added CA logo and removed navigation and toc from index page. (#968) * Added CA logo and removed navigation and toc from index page. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Renamed logo file. Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/img/ca-logo-white.svg | 1 + docs/index.md | 6 ++++++ mkdocs.yml | 3 +++ 3 files changed, 10 insertions(+) create mode 100644 docs/img/ca-logo-white.svg diff --git a/docs/img/ca-logo-white.svg b/docs/img/ca-logo-white.svg new file mode 100644 index 0000000000..6030749076 --- /dev/null +++ b/docs/img/ca-logo-white.svg @@ -0,0 +1 @@ + diff --git a/docs/index.md b/docs/index.md index ba6becc0b2..6ebf021284 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,9 @@ +--- +hide: + - navigation + - toc +--- + # CivicActions Guidebook [![Documentation Status](https://readthedocs.org/projects/civicactions-handbook/badge/?version=latest)](https://handbook.civicactions.com/en/latest/?badge=latest) diff --git a/mkdocs.yml b/mkdocs.yml index 0eae002371..52f14a788a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ theme: - navigation.tabs - navigation.expand favicon: img/favicon.ico + logo: img/ca-logo-white.svg palette: # Palette toggle for light mode - scheme: default @@ -25,3 +26,5 @@ plugins: - search extra_css: - css/extra.css +#nav: +#- Welcome: index.md From e1f0c95bd425845fa5a149b958effdf3ff9e7029 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Mon, 19 Dec 2022 15:24:04 -0800 Subject: [PATCH 09/20] Added jquery for the read the docs flyout menu. --- mkdocs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 52f14a788a..ef64eee28a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,5 +26,10 @@ plugins: - search extra_css: - css/extra.css +extra_javascript: +#- js/extra.js +# Read the Docs requires JQuery for its JavaScript code to inject the flyout +# menu. Material for MkDocs does not come with JQuery. + - 'https://code.jquery.com/jquery-3.6.2.min.js' #nav: #- Welcome: index.md From d6828b4234bb6b7620859dbad941ae0c0a057bca Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 19 Dec 2022 23:27:08 +0000 Subject: [PATCH 10/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index ef64eee28a..bb9fbe3ff4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,9 +27,9 @@ plugins: extra_css: - css/extra.css extra_javascript: -#- js/extra.js -# Read the Docs requires JQuery for its JavaScript code to inject the flyout -# menu. Material for MkDocs does not come with JQuery. - - 'https://code.jquery.com/jquery-3.6.2.min.js' + #- js/extra.js + # Read the Docs requires JQuery for its JavaScript code to inject the flyout + # menu. Material for MkDocs does not come with JQuery. + - "https://code.jquery.com/jquery-3.6.2.min.js" #nav: #- Welcome: index.md From 870a501e7331014e91c7cc7c0353996b7c86dfe4 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Mon, 19 Dec 2022 15:29:40 -0800 Subject: [PATCH 11/20] Updated CSS for rst-versions. --- docs/css/extra.css | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/css/extra.css b/docs/css/extra.css index 7df01a699b..7952ddb38f 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -9,3 +9,11 @@ .md-search__form { background-color: #d83933; } +/* The Read the Docs flyout is formatted with a font-size that is 90% of the +body's. Material for MkDocs has a body font-size that is 0.5rem. This font-size +will result in the flyout having a font-size of 0.7rem, consistent with the +font-size of other elements in the theme. +*/ +.rst-versions { + font-size: 0.777778rem; +} From a48c84a3d46e4364b351e6df2a63a89a080ce25e Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Wed, 21 Dec 2022 12:41:09 -0800 Subject: [PATCH 12/20] Commenting out nav expand and adding nav indexes. --- mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index bb9fbe3ff4..819be27ff8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,8 @@ theme: name: material features: - navigation.tabs - - navigation.expand + - navigation.indexes + #- navigation.expand favicon: img/favicon.ico logo: img/ca-logo-white.svg palette: From 023f723a8fcaaef98a0584af4eb011b1cf70578e Mon Sep 17 00:00:00 2001 From: Denise Eisner <92043982+ContentBrewmaster@users.noreply.github.com> Date: Thu, 22 Dec 2022 15:08:33 -0500 Subject: [PATCH 13/20] Material theme beta nav (#974) * Update mkdocs.yml Mapped new guidebook structure to existing handbook structure. * Update mkdocs.yml Fixed typo. * Update mkdocs.yml Fixed typos. * Update mkdocs.yml Added missing files. * Update mkdocs.yml Fixed typos and adjusted Yubikey section. * Update mkdocs.yml Fixed grouping and typo. * Adjusting yubikey menu. * Removed deleted page from nav and added new PM page to nav. Co-authored-by: Daniel Mundra --- mkdocs.yml | 164 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 162 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 819be27ff8..3943b37930 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,5 +32,165 @@ extra_javascript: # Read the Docs requires JQuery for its JavaScript code to inject the flyout # menu. Material for MkDocs does not come with JQuery. - "https://code.jquery.com/jquery-3.6.2.min.js" -#nav: -#- Welcome: index.md +nav: + - Home: index.md + - About CivicActions: + - Mission and values: 020-about-us/mission-values.md + - Culture: 020-about-us/culture.md + - Diversity, Equity, Inclusion, and Accessibility (DEIA): + - DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md + - Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md + - Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md + - DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md + - Resources: 050-how-we-work/diversity-equity-inclusion/resources.md + - Our structure: + - Departments, projects, practice areas, and pods: 050-how-we-work/organization.md + - Organizational structure: 020-about-us/org-structure.md + - Management team: 050-how-we-work/management-ops.md + - Background and history: 020-about-us/background-and-history.md + - Our annual summit: 030-policies/annual-retreat.md + - Employee benefits: + - Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md + - Compensation (US employees): 040-employee-handbook-us/compensation.md + - Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md + - Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md + - Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md + - Professional development: 030-policies/prodev.md + - Employee referral bonus program: 030-policies/employee-referral-bonus.md + - On-call stipends: 030-policies/on-call-stipend.md + - Company policies: + - Expenses: 030-policies/expenses.md + - Travel expenses and billing: 030-policies/travel-101.md + - Timesheets (Unanet): 050-how-we-work/tools/unanet.md + - Security Policy: 030-policies/security.md + - Employment policies (US employees): + - Employment: 040-employee-handbook-us/employment.md + - Introductory period: 040-employee-handbook-us/introductory-period.md + - Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md + - Covid 19 safety: 040-employee-handbook-us/covid19safety.md + - Code of conduct: 030-policies/code-of-conduct.md + - Workplace guidelines: 030-policies/workplace-guidelines.md + - Annual performance review: 030-policies/annual-review-process.md + - Performance management: 030-policies/performance-management.md + - Leaving Civicactions: 030-policies/leaving-civicactions.md + - Health, Safety and Security Policy: 030-policies/health-safety-security.md + - New hire orientation: + - Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md + - Buddy program: 010-welcome-to-civicactions/training/buddy-program.md + - Elevator pitch: 020-about-us/elevator-pitch.md + - Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md + - Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md + - People planning: 010-welcome-to-civicactions/training/people-planning.md + - Security for everyone: 010-welcome-to-civicactions/training/security-training.md + - Training resources: 050-how-we-work/training-resources.md + - Video call best practices: 050-how-we-work/video-call-best-practices.md + - Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md + - Common practices and tools: + - Agile: + - Agile overview: 050-how-we-work/agile-overview.md + - Agile practice: 050-how-we-work/agile-practices/README.md + - Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md + - Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md + - How to create tickets: 050-how-we-work/tools/tickets-cards.md + - Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md + - Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md + - Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md + - Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md + - Balance scores: 050-how-we-work/balance-scores.md + - Gold Star Program: 050-how-we-work/gold-star-program.md + - Security awareness and tools: + - Awareness and tools: 100-security/awareness.md + - Setting up and using Yubikey: + - 100-security/yubikey/README.md + - Yubikey and Linux: 100-security/yubikey/linux.md + - Yubikey and Mac OS: 100-security/yubikey/macosx.md + - Drupal RMF support: 100-security/drupal-rmf-support.md + - Encryption: 100-security/encryption.md + - Incidents: + - Contingency plan: 100-security/contingency-plan.md + - Incident response checklist: 100-security/incident-response-checklist.md + - Incident response plan: 100-security/incident-response-plan.md + - Security incidents: 100-security/incidents.md + - Skills Base: 050-how-we-work/tools/skills-base.md + - Software and support: + - Internal technical support: 050-how-we-work/support.md + - Bookmarks: 050-how-we-work/bookmarks.md + - Email: 050-how-we-work/tools/email.md + - General contacts and listservs: 020-about-us/general-contacts-and-listservs.md + - Github: 050-how-we-work/tools/github.md + - Google Calendar: 050-how-we-work/tools/google-calendar.md + - Google Docs: 050-how-we-work/tools/google-docs.md + - Google Meet: 050-how-we-work/tools/google-hangouts.md + - Jira: 050-how-we-work/tools/jira.md + - Markdown: 050-how-we-work/tools/markdown.md + - Slack: 050-how-we-work/tools/slack.md + - Text editors: 050-how-we-work/tools/text-editors.md + - Trello: 050-how-we-work/tools/trello.md + - Zoom: 050-how-we-work/tools/zoom.md + - Telephone use: 050-how-we-work/tools/telephone.md + - Practice areas: + - About practice areas: 050-how-we-work/practice-areas/README.md + - Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md + - Design and research: + - Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md + - Content audit guide: 110-ux/services/research/content-audit-guide.md + - Content modeling guide: 110-ux/services/design/content-modeling-guide.md + - Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md + - Story mapping guide: 110-ux/services/research/story-mapping-guide.md + - Usability testing guide: 110-ux/services/research/usability-testing-guide.md + - User personas guide: 110-ux/services/research/user-personas-guide.md + - Engineering: + - Engineering calls: 060-engineering/README.md + - Accessibility: 060-engineering/accessibility.md + - Backend development: 060-engineering/back-end-development.md + - Development and hosting environments: 060-engineering/dev-environments.md + - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md + - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md + - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md + - Drupal site building: 060-engineering/drupal-site-building.md + - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md + - Engineering: 060-engineering/README.md + - Engineering project roles: 060-engineering/engineering-roles.md + - Git: 060-engineering/git.md + - How to log internal meetings: 060-engineering/internalmeetings.md + - Quality assurance: 060-engineering/qa.md + - Security and compliance: 060-engineering/security-compliance.md + - Systems and sandboxes: 060-engineering/systems-sandboxes.md + - Tech Lead (TL) project role description: 060-engineering/tech-lead.md + - CSS (and SASS etc.): 060-engineering/front-end/css.md + - Development tools: 060-engineering/front-end/front-end-tools.md + - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md + - Front-end development: 060-engineering/front-end/README.md + - Front-end testing: 060-engineering/front-end/testing.md + - Help desk: + - Help desk support: 120-help-desk/helpdesk.md + - Project support and Agile: 120-help-desk/help-desk-agile.md + - Help desk working practices: 120-help-desk/working-practices.md + - Project management: + - Project manager role: 070-project-management/pm-role.md + - Guidelines for starting a new project: 070-project-management/starting-new-project.md + - Invoicing: 070-project-management/invoicing.md + - Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md + - When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md + - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md + - Tracking contractual requirements: 070-project-management/contractual-requirements.md + - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md + - Time off request and approval process: 070-project-management/pto-request-approval-process.md + - Having the hard conversations: 070-project-management/hard-conversations.md + - Listserv setup: 070-project-management/listserv-setup.md + - Offboarding a team member from a project: 070-project-management/project-offboarding.md + - Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md + - Project calendar: 070-project-management/project-calendar.md + - Project folder structure: 070-project-management/project-folder.md + - Project Manager templates: 070-project-management/templates.md + - Project Manager training: 070-project-management/pm-training.md + - Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md + - About this guidebook: + - How and when to contribute to the guidebook: 000-contributing/README.md + - File structure: 000-contributing/file-structure.md + - Git workflow: 000-contributing/git-workflow.md + - GitHub actions: 000-contributing/github-actions.md + - Guidebook governance: 000-contributing/docs-governance.md + - Guidebook writing style: 000-contributing/writing-style-guide.md + - Markdown: 000-contributing/markdown.md + - License: LICENSE.md From 1b8a510481c02422915a7b6ba4b245d4989b1e00 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Thu, 22 Dec 2022 15:52:20 -0800 Subject: [PATCH 14/20] Added comments and adjusteds indentation of the menu items (switched to 2 spaces identation). --- mkdocs.yml | 310 +++++++++++++++++++++++++++-------------------------- 1 file changed, 156 insertions(+), 154 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 3943b37930..ea0da4b46e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,165 +32,167 @@ extra_javascript: # Read the Docs requires JQuery for its JavaScript code to inject the flyout # menu. Material for MkDocs does not come with JQuery. - "https://code.jquery.com/jquery-3.6.2.min.js" +# Navigation of the entire site is managed below, both the main menu items and their child pages. nav: - Home: index.md - About CivicActions: - - Mission and values: 020-about-us/mission-values.md - - Culture: 020-about-us/culture.md - - Diversity, Equity, Inclusion, and Accessibility (DEIA): - - DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md - - Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md - - Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md - - DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md - - Resources: 050-how-we-work/diversity-equity-inclusion/resources.md - - Our structure: - - Departments, projects, practice areas, and pods: 050-how-we-work/organization.md - - Organizational structure: 020-about-us/org-structure.md - - Management team: 050-how-we-work/management-ops.md - - Background and history: 020-about-us/background-and-history.md - - Our annual summit: 030-policies/annual-retreat.md + - Mission and values: 020-about-us/mission-values.md + - Culture: 020-about-us/culture.md + - Diversity, Equity, Inclusion, and Accessibility (DEIA): + - DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md + - Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md + - Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md + - DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md + - Resources: 050-how-we-work/diversity-equity-inclusion/resources.md + - Our structure: + - Departments, projects, practice areas, and pods: 050-how-we-work/organization.md + - Organizational structure: 020-about-us/org-structure.md + - Management team: 050-how-we-work/management-ops.md + - Background and history: 020-about-us/background-and-history.md + - Our annual summit: 030-policies/annual-retreat.md - Employee benefits: - - Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md - - Compensation (US employees): 040-employee-handbook-us/compensation.md - - Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md - - Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md - - Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md - - Professional development: 030-policies/prodev.md - - Employee referral bonus program: 030-policies/employee-referral-bonus.md - - On-call stipends: 030-policies/on-call-stipend.md + - Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md + - Compensation (US employees): 040-employee-handbook-us/compensation.md + - Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md + - Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md + - Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md + - Professional development: 030-policies/prodev.md + - Employee referral bonus program: 030-policies/employee-referral-bonus.md + - On-call stipends: 030-policies/on-call-stipend.md - Company policies: - - Expenses: 030-policies/expenses.md - - Travel expenses and billing: 030-policies/travel-101.md - - Timesheets (Unanet): 050-how-we-work/tools/unanet.md - - Security Policy: 030-policies/security.md - - Employment policies (US employees): - - Employment: 040-employee-handbook-us/employment.md - - Introductory period: 040-employee-handbook-us/introductory-period.md - - Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md - - Covid 19 safety: 040-employee-handbook-us/covid19safety.md - - Code of conduct: 030-policies/code-of-conduct.md - - Workplace guidelines: 030-policies/workplace-guidelines.md - - Annual performance review: 030-policies/annual-review-process.md - - Performance management: 030-policies/performance-management.md - - Leaving Civicactions: 030-policies/leaving-civicactions.md - - Health, Safety and Security Policy: 030-policies/health-safety-security.md - - New hire orientation: - - Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md - - Buddy program: 010-welcome-to-civicactions/training/buddy-program.md - - Elevator pitch: 020-about-us/elevator-pitch.md - - Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md - - Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md - - People planning: 010-welcome-to-civicactions/training/people-planning.md - - Security for everyone: 010-welcome-to-civicactions/training/security-training.md - - Training resources: 050-how-we-work/training-resources.md - - Video call best practices: 050-how-we-work/video-call-best-practices.md - - Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md + - Expenses: 030-policies/expenses.md + - Travel expenses and billing: 030-policies/travel-101.md + - Timesheets (Unanet): 050-how-we-work/tools/unanet.md + - Security Policy: 030-policies/security.md + - Employment policies (US employees): + - Employment: 040-employee-handbook-us/employment.md + - Introductory period: 040-employee-handbook-us/introductory-period.md + - Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md + - Covid 19 safety: 040-employee-handbook-us/covid19safety.md + - Code of conduct: 030-policies/code-of-conduct.md + - Workplace guidelines: 030-policies/workplace-guidelines.md + - Annual performance review: 030-policies/annual-review-process.md + - Performance management: 030-policies/performance-management.md + - Leaving Civicactions: 030-policies/leaving-civicactions.md + - Health, Safety and Security Policy: 030-policies/health-safety-security.md + - New hire orientation: + - Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md + - Buddy program: 010-welcome-to-civicactions/training/buddy-program.md + - Elevator pitch: 020-about-us/elevator-pitch.md + - Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md + - Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md + - People planning: 010-welcome-to-civicactions/training/people-planning.md + - Security for everyone: 010-welcome-to-civicactions/training/security-training.md + - Training resources: 050-how-we-work/training-resources.md + - Video call best practices: 050-how-we-work/video-call-best-practices.md + - Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md - Common practices and tools: - - Agile: - - Agile overview: 050-how-we-work/agile-overview.md - - Agile practice: 050-how-we-work/agile-practices/README.md - - Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md - - Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md - - How to create tickets: 050-how-we-work/tools/tickets-cards.md - - Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md - - Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md - - Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md - - Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md - - Balance scores: 050-how-we-work/balance-scores.md - - Gold Star Program: 050-how-we-work/gold-star-program.md - - Security awareness and tools: - - Awareness and tools: 100-security/awareness.md - - Setting up and using Yubikey: - - 100-security/yubikey/README.md - - Yubikey and Linux: 100-security/yubikey/linux.md - - Yubikey and Mac OS: 100-security/yubikey/macosx.md - - Drupal RMF support: 100-security/drupal-rmf-support.md - - Encryption: 100-security/encryption.md - - Incidents: - - Contingency plan: 100-security/contingency-plan.md - - Incident response checklist: 100-security/incident-response-checklist.md - - Incident response plan: 100-security/incident-response-plan.md - - Security incidents: 100-security/incidents.md - - Skills Base: 050-how-we-work/tools/skills-base.md - - Software and support: - - Internal technical support: 050-how-we-work/support.md - - Bookmarks: 050-how-we-work/bookmarks.md - - Email: 050-how-we-work/tools/email.md - - General contacts and listservs: 020-about-us/general-contacts-and-listservs.md - - Github: 050-how-we-work/tools/github.md - - Google Calendar: 050-how-we-work/tools/google-calendar.md - - Google Docs: 050-how-we-work/tools/google-docs.md - - Google Meet: 050-how-we-work/tools/google-hangouts.md - - Jira: 050-how-we-work/tools/jira.md - - Markdown: 050-how-we-work/tools/markdown.md - - Slack: 050-how-we-work/tools/slack.md - - Text editors: 050-how-we-work/tools/text-editors.md - - Trello: 050-how-we-work/tools/trello.md - - Zoom: 050-how-we-work/tools/zoom.md - - Telephone use: 050-how-we-work/tools/telephone.md + - Agile: + - Agile overview: 050-how-we-work/agile-overview.md + - Agile practice: 050-how-we-work/agile-practices/README.md + - Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md + - Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md + - How to create tickets: 050-how-we-work/tools/tickets-cards.md + - Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md + - Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md + - Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md + - Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md + - Balance scores: 050-how-we-work/balance-scores.md + - Gold Star Program: 050-how-we-work/gold-star-program.md + - Security awareness and tools: + - Awareness and tools: 100-security/awareness.md + - Setting up and using Yubikey: + - 100-security/yubikey/README.md + - Yubikey and Linux: 100-security/yubikey/linux.md + - Yubikey and Mac OS: 100-security/yubikey/macosx.md + - Drupal RMF support: 100-security/drupal-rmf-support.md + - Encryption: 100-security/encryption.md + - Incidents: + - Contingency plan: 100-security/contingency-plan.md + - Incident response checklist: 100-security/incident-response-checklist.md + - Incident response plan: 100-security/incident-response-plan.md + - Security incidents: 100-security/incidents.md + - Skills Base: 050-how-we-work/tools/skills-base.md + - Software and support: + - Internal technical support: 050-how-we-work/support.md + - Bookmarks: 050-how-we-work/bookmarks.md + - Email: 050-how-we-work/tools/email.md + - General contacts and listservs: 020-about-us/general-contacts-and-listservs.md + - Github: 050-how-we-work/tools/github.md + - Google Calendar: 050-how-we-work/tools/google-calendar.md + - Google Docs: 050-how-we-work/tools/google-docs.md + - Google Meet: 050-how-we-work/tools/google-hangouts.md + - Jira: 050-how-we-work/tools/jira.md + - Markdown: 050-how-we-work/tools/markdown.md + - Slack: 050-how-we-work/tools/slack.md + - Text editors: 050-how-we-work/tools/text-editors.md + - Trello: 050-how-we-work/tools/trello.md + - Zoom: 050-how-we-work/tools/zoom.md + - Telephone use: 050-how-we-work/tools/telephone.md - Practice areas: - - About practice areas: 050-how-we-work/practice-areas/README.md - - Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md - - Design and research: - - Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md - - Content audit guide: 110-ux/services/research/content-audit-guide.md - - Content modeling guide: 110-ux/services/design/content-modeling-guide.md - - Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md - - Story mapping guide: 110-ux/services/research/story-mapping-guide.md - - Usability testing guide: 110-ux/services/research/usability-testing-guide.md - - User personas guide: 110-ux/services/research/user-personas-guide.md - - Engineering: - - Engineering calls: 060-engineering/README.md - - Accessibility: 060-engineering/accessibility.md - - Backend development: 060-engineering/back-end-development.md - - Development and hosting environments: 060-engineering/dev-environments.md - - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md - - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md - - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md - - Drupal site building: 060-engineering/drupal-site-building.md - - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md - - Engineering: 060-engineering/README.md - - Engineering project roles: 060-engineering/engineering-roles.md - - Git: 060-engineering/git.md - - How to log internal meetings: 060-engineering/internalmeetings.md - - Quality assurance: 060-engineering/qa.md - - Security and compliance: 060-engineering/security-compliance.md - - Systems and sandboxes: 060-engineering/systems-sandboxes.md - - Tech Lead (TL) project role description: 060-engineering/tech-lead.md - - CSS (and SASS etc.): 060-engineering/front-end/css.md - - Development tools: 060-engineering/front-end/front-end-tools.md - - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md - - Front-end development: 060-engineering/front-end/README.md - - Front-end testing: 060-engineering/front-end/testing.md - - Help desk: - - Help desk support: 120-help-desk/helpdesk.md - - Project support and Agile: 120-help-desk/help-desk-agile.md - - Help desk working practices: 120-help-desk/working-practices.md - - Project management: - - Project manager role: 070-project-management/pm-role.md - - Guidelines for starting a new project: 070-project-management/starting-new-project.md - - Invoicing: 070-project-management/invoicing.md - - Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md - - When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md - - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md - - Tracking contractual requirements: 070-project-management/contractual-requirements.md - - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md - - Time off request and approval process: 070-project-management/pto-request-approval-process.md - - Having the hard conversations: 070-project-management/hard-conversations.md - - Listserv setup: 070-project-management/listserv-setup.md - - Offboarding a team member from a project: 070-project-management/project-offboarding.md - - Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md - - Project calendar: 070-project-management/project-calendar.md - - Project folder structure: 070-project-management/project-folder.md - - Project Manager templates: 070-project-management/templates.md - - Project Manager training: 070-project-management/pm-training.md - - Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md + - About practice areas: 050-how-we-work/practice-areas/README.md + - Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md + - Design and research: + - Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md + - Content audit guide: 110-ux/services/research/content-audit-guide.md + - Content modeling guide: 110-ux/services/design/content-modeling-guide.md + - Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md + - Story mapping guide: 110-ux/services/research/story-mapping-guide.md + - Usability testing guide: 110-ux/services/research/usability-testing-guide.md + - User personas guide: 110-ux/services/research/user-personas-guide.md + - Engineering: + - Engineering calls: 060-engineering/README.md + - Accessibility: 060-engineering/accessibility.md + - Backend development: 060-engineering/back-end-development.md + - Development and hosting environments: 060-engineering/dev-environments.md + - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md + - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md + - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md + - Drupal site building: 060-engineering/drupal-site-building.md + - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md + - Engineering: 060-engineering/README.md + - Engineering project roles: 060-engineering/engineering-roles.md + - Git: 060-engineering/git.md + - How to log internal meetings: 060-engineering/internalmeetings.md + - Quality assurance: 060-engineering/qa.md + - Security and compliance: 060-engineering/security-compliance.md + - Systems and sandboxes: 060-engineering/systems-sandboxes.md + - Tech Lead (TL) project role description: 060-engineering/tech-lead.md + - CSS (and SASS etc.): 060-engineering/front-end/css.md + - Development tools: 060-engineering/front-end/front-end-tools.md + - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md + - Front-end development: 060-engineering/front-end/README.md + - Front-end testing: 060-engineering/front-end/testing.md + - Help desk: + - Help desk support: 120-help-desk/helpdesk.md + - Project support and Agile: 120-help-desk/help-desk-agile.md + - Help desk working practices: 120-help-desk/working-practices.md + - Project management: + - Project manager role: 070-project-management/pm-role.md + - Guidelines for starting a new project: 070-project-management/starting-new-project.md + - Invoicing: 070-project-management/invoicing.md + - Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md + - When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md + - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md + - Tracking contractual requirements: 070-project-management/contractual-requirements.md + - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md + - Time off request and approval process: 070-project-management/pto-request-approval-process.md + - Having the hard conversations: 070-project-management/hard-conversations.md + - Listserv setup: 070-project-management/listserv-setup.md + - Offboarding a team member from a project: 070-project-management/project-offboarding.md + - Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md + - Project calendar: 070-project-management/project-calendar.md + - Project folder structure: 070-project-management/project-folder.md + - Project Manager templates: 070-project-management/templates.md + - Project Manager training: 070-project-management/pm-training.md + - Project Management Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md + - Project Management Checklists: 070-project-management/project-management-checklists.md - About this guidebook: - - How and when to contribute to the guidebook: 000-contributing/README.md - - File structure: 000-contributing/file-structure.md - - Git workflow: 000-contributing/git-workflow.md - - GitHub actions: 000-contributing/github-actions.md - - Guidebook governance: 000-contributing/docs-governance.md - - Guidebook writing style: 000-contributing/writing-style-guide.md - - Markdown: 000-contributing/markdown.md - - License: LICENSE.md + - How and when to contribute to the guidebook: 000-contributing/README.md + - File structure: 000-contributing/file-structure.md + - Git workflow: 000-contributing/git-workflow.md + - GitHub actions: 000-contributing/github-actions.md + - Guidebook governance: 000-contributing/docs-governance.md + - Guidebook writing style: 000-contributing/writing-style-guide.md + - Markdown: 000-contributing/markdown.md + - License: LICENSE.md From 778253de20da37066178a2cb821fbdbadfa8959e Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 22 Dec 2022 23:52:44 +0000 Subject: [PATCH 15/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- mkdocs.yml | 310 ++++++++++++++++++++++++++--------------------------- 1 file changed, 155 insertions(+), 155 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index ea0da4b46e..0be88e0e23 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,163 +36,163 @@ extra_javascript: nav: - Home: index.md - About CivicActions: - - Mission and values: 020-about-us/mission-values.md - - Culture: 020-about-us/culture.md - - Diversity, Equity, Inclusion, and Accessibility (DEIA): - - DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md - - Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md - - Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md - - DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md - - Resources: 050-how-we-work/diversity-equity-inclusion/resources.md - - Our structure: - - Departments, projects, practice areas, and pods: 050-how-we-work/organization.md - - Organizational structure: 020-about-us/org-structure.md - - Management team: 050-how-we-work/management-ops.md - - Background and history: 020-about-us/background-and-history.md - - Our annual summit: 030-policies/annual-retreat.md + - Mission and values: 020-about-us/mission-values.md + - Culture: 020-about-us/culture.md + - Diversity, Equity, Inclusion, and Accessibility (DEIA): + - DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md + - Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md + - Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md + - DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md + - Resources: 050-how-we-work/diversity-equity-inclusion/resources.md + - Our structure: + - Departments, projects, practice areas, and pods: 050-how-we-work/organization.md + - Organizational structure: 020-about-us/org-structure.md + - Management team: 050-how-we-work/management-ops.md + - Background and history: 020-about-us/background-and-history.md + - Our annual summit: 030-policies/annual-retreat.md - Employee benefits: - - Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md - - Compensation (US employees): 040-employee-handbook-us/compensation.md - - Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md - - Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md - - Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md - - Professional development: 030-policies/prodev.md - - Employee referral bonus program: 030-policies/employee-referral-bonus.md - - On-call stipends: 030-policies/on-call-stipend.md + - Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md + - Compensation (US employees): 040-employee-handbook-us/compensation.md + - Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md + - Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md + - Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md + - Professional development: 030-policies/prodev.md + - Employee referral bonus program: 030-policies/employee-referral-bonus.md + - On-call stipends: 030-policies/on-call-stipend.md - Company policies: - - Expenses: 030-policies/expenses.md - - Travel expenses and billing: 030-policies/travel-101.md - - Timesheets (Unanet): 050-how-we-work/tools/unanet.md - - Security Policy: 030-policies/security.md - - Employment policies (US employees): - - Employment: 040-employee-handbook-us/employment.md - - Introductory period: 040-employee-handbook-us/introductory-period.md - - Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md - - Covid 19 safety: 040-employee-handbook-us/covid19safety.md - - Code of conduct: 030-policies/code-of-conduct.md - - Workplace guidelines: 030-policies/workplace-guidelines.md - - Annual performance review: 030-policies/annual-review-process.md - - Performance management: 030-policies/performance-management.md - - Leaving Civicactions: 030-policies/leaving-civicactions.md - - Health, Safety and Security Policy: 030-policies/health-safety-security.md - - New hire orientation: - - Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md - - Buddy program: 010-welcome-to-civicactions/training/buddy-program.md - - Elevator pitch: 020-about-us/elevator-pitch.md - - Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md - - Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md - - People planning: 010-welcome-to-civicactions/training/people-planning.md - - Security for everyone: 010-welcome-to-civicactions/training/security-training.md - - Training resources: 050-how-we-work/training-resources.md - - Video call best practices: 050-how-we-work/video-call-best-practices.md - - Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md + - Expenses: 030-policies/expenses.md + - Travel expenses and billing: 030-policies/travel-101.md + - Timesheets (Unanet): 050-how-we-work/tools/unanet.md + - Security Policy: 030-policies/security.md + - Employment policies (US employees): + - Employment: 040-employee-handbook-us/employment.md + - Introductory period: 040-employee-handbook-us/introductory-period.md + - Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md + - Covid 19 safety: 040-employee-handbook-us/covid19safety.md + - Code of conduct: 030-policies/code-of-conduct.md + - Workplace guidelines: 030-policies/workplace-guidelines.md + - Annual performance review: 030-policies/annual-review-process.md + - Performance management: 030-policies/performance-management.md + - Leaving Civicactions: 030-policies/leaving-civicactions.md + - Health, Safety and Security Policy: 030-policies/health-safety-security.md + - New hire orientation: + - Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md + - Buddy program: 010-welcome-to-civicactions/training/buddy-program.md + - Elevator pitch: 020-about-us/elevator-pitch.md + - Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md + - Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md + - People planning: 010-welcome-to-civicactions/training/people-planning.md + - Security for everyone: 010-welcome-to-civicactions/training/security-training.md + - Training resources: 050-how-we-work/training-resources.md + - Video call best practices: 050-how-we-work/video-call-best-practices.md + - Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md - Common practices and tools: - - Agile: - - Agile overview: 050-how-we-work/agile-overview.md - - Agile practice: 050-how-we-work/agile-practices/README.md - - Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md - - Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md - - How to create tickets: 050-how-we-work/tools/tickets-cards.md - - Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md - - Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md - - Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md - - Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md - - Balance scores: 050-how-we-work/balance-scores.md - - Gold Star Program: 050-how-we-work/gold-star-program.md - - Security awareness and tools: - - Awareness and tools: 100-security/awareness.md - - Setting up and using Yubikey: - - 100-security/yubikey/README.md - - Yubikey and Linux: 100-security/yubikey/linux.md - - Yubikey and Mac OS: 100-security/yubikey/macosx.md - - Drupal RMF support: 100-security/drupal-rmf-support.md - - Encryption: 100-security/encryption.md - - Incidents: - - Contingency plan: 100-security/contingency-plan.md - - Incident response checklist: 100-security/incident-response-checklist.md - - Incident response plan: 100-security/incident-response-plan.md - - Security incidents: 100-security/incidents.md - - Skills Base: 050-how-we-work/tools/skills-base.md - - Software and support: - - Internal technical support: 050-how-we-work/support.md - - Bookmarks: 050-how-we-work/bookmarks.md - - Email: 050-how-we-work/tools/email.md - - General contacts and listservs: 020-about-us/general-contacts-and-listservs.md - - Github: 050-how-we-work/tools/github.md - - Google Calendar: 050-how-we-work/tools/google-calendar.md - - Google Docs: 050-how-we-work/tools/google-docs.md - - Google Meet: 050-how-we-work/tools/google-hangouts.md - - Jira: 050-how-we-work/tools/jira.md - - Markdown: 050-how-we-work/tools/markdown.md - - Slack: 050-how-we-work/tools/slack.md - - Text editors: 050-how-we-work/tools/text-editors.md - - Trello: 050-how-we-work/tools/trello.md - - Zoom: 050-how-we-work/tools/zoom.md - - Telephone use: 050-how-we-work/tools/telephone.md + - Agile: + - Agile overview: 050-how-we-work/agile-overview.md + - Agile practice: 050-how-we-work/agile-practices/README.md + - Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md + - Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md + - How to create tickets: 050-how-we-work/tools/tickets-cards.md + - Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md + - Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md + - Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md + - Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md + - Balance scores: 050-how-we-work/balance-scores.md + - Gold Star Program: 050-how-we-work/gold-star-program.md + - Security awareness and tools: + - Awareness and tools: 100-security/awareness.md + - Setting up and using Yubikey: + - 100-security/yubikey/README.md + - Yubikey and Linux: 100-security/yubikey/linux.md + - Yubikey and Mac OS: 100-security/yubikey/macosx.md + - Drupal RMF support: 100-security/drupal-rmf-support.md + - Encryption: 100-security/encryption.md + - Incidents: + - Contingency plan: 100-security/contingency-plan.md + - Incident response checklist: 100-security/incident-response-checklist.md + - Incident response plan: 100-security/incident-response-plan.md + - Security incidents: 100-security/incidents.md + - Skills Base: 050-how-we-work/tools/skills-base.md + - Software and support: + - Internal technical support: 050-how-we-work/support.md + - Bookmarks: 050-how-we-work/bookmarks.md + - Email: 050-how-we-work/tools/email.md + - General contacts and listservs: 020-about-us/general-contacts-and-listservs.md + - Github: 050-how-we-work/tools/github.md + - Google Calendar: 050-how-we-work/tools/google-calendar.md + - Google Docs: 050-how-we-work/tools/google-docs.md + - Google Meet: 050-how-we-work/tools/google-hangouts.md + - Jira: 050-how-we-work/tools/jira.md + - Markdown: 050-how-we-work/tools/markdown.md + - Slack: 050-how-we-work/tools/slack.md + - Text editors: 050-how-we-work/tools/text-editors.md + - Trello: 050-how-we-work/tools/trello.md + - Zoom: 050-how-we-work/tools/zoom.md + - Telephone use: 050-how-we-work/tools/telephone.md - Practice areas: - - About practice areas: 050-how-we-work/practice-areas/README.md - - Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md - - Design and research: - - Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md - - Content audit guide: 110-ux/services/research/content-audit-guide.md - - Content modeling guide: 110-ux/services/design/content-modeling-guide.md - - Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md - - Story mapping guide: 110-ux/services/research/story-mapping-guide.md - - Usability testing guide: 110-ux/services/research/usability-testing-guide.md - - User personas guide: 110-ux/services/research/user-personas-guide.md - - Engineering: - - Engineering calls: 060-engineering/README.md - - Accessibility: 060-engineering/accessibility.md - - Backend development: 060-engineering/back-end-development.md - - Development and hosting environments: 060-engineering/dev-environments.md - - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md - - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md - - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md - - Drupal site building: 060-engineering/drupal-site-building.md - - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md - - Engineering: 060-engineering/README.md - - Engineering project roles: 060-engineering/engineering-roles.md - - Git: 060-engineering/git.md - - How to log internal meetings: 060-engineering/internalmeetings.md - - Quality assurance: 060-engineering/qa.md - - Security and compliance: 060-engineering/security-compliance.md - - Systems and sandboxes: 060-engineering/systems-sandboxes.md - - Tech Lead (TL) project role description: 060-engineering/tech-lead.md - - CSS (and SASS etc.): 060-engineering/front-end/css.md - - Development tools: 060-engineering/front-end/front-end-tools.md - - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md - - Front-end development: 060-engineering/front-end/README.md - - Front-end testing: 060-engineering/front-end/testing.md - - Help desk: - - Help desk support: 120-help-desk/helpdesk.md - - Project support and Agile: 120-help-desk/help-desk-agile.md - - Help desk working practices: 120-help-desk/working-practices.md - - Project management: - - Project manager role: 070-project-management/pm-role.md - - Guidelines for starting a new project: 070-project-management/starting-new-project.md - - Invoicing: 070-project-management/invoicing.md - - Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md - - When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md - - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md - - Tracking contractual requirements: 070-project-management/contractual-requirements.md - - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md - - Time off request and approval process: 070-project-management/pto-request-approval-process.md - - Having the hard conversations: 070-project-management/hard-conversations.md - - Listserv setup: 070-project-management/listserv-setup.md - - Offboarding a team member from a project: 070-project-management/project-offboarding.md - - Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md - - Project calendar: 070-project-management/project-calendar.md - - Project folder structure: 070-project-management/project-folder.md - - Project Manager templates: 070-project-management/templates.md - - Project Manager training: 070-project-management/pm-training.md - - Project Management Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md - - Project Management Checklists: 070-project-management/project-management-checklists.md + - About practice areas: 050-how-we-work/practice-areas/README.md + - Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md + - Design and research: + - Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md + - Content audit guide: 110-ux/services/research/content-audit-guide.md + - Content modeling guide: 110-ux/services/design/content-modeling-guide.md + - Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md + - Story mapping guide: 110-ux/services/research/story-mapping-guide.md + - Usability testing guide: 110-ux/services/research/usability-testing-guide.md + - User personas guide: 110-ux/services/research/user-personas-guide.md + - Engineering: + - Engineering calls: 060-engineering/README.md + - Accessibility: 060-engineering/accessibility.md + - Backend development: 060-engineering/back-end-development.md + - Development and hosting environments: 060-engineering/dev-environments.md + - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md + - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md + - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md + - Drupal site building: 060-engineering/drupal-site-building.md + - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md + - Engineering: 060-engineering/README.md + - Engineering project roles: 060-engineering/engineering-roles.md + - Git: 060-engineering/git.md + - How to log internal meetings: 060-engineering/internalmeetings.md + - Quality assurance: 060-engineering/qa.md + - Security and compliance: 060-engineering/security-compliance.md + - Systems and sandboxes: 060-engineering/systems-sandboxes.md + - Tech Lead (TL) project role description: 060-engineering/tech-lead.md + - CSS (and SASS etc.): 060-engineering/front-end/css.md + - Development tools: 060-engineering/front-end/front-end-tools.md + - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md + - Front-end development: 060-engineering/front-end/README.md + - Front-end testing: 060-engineering/front-end/testing.md + - Help desk: + - Help desk support: 120-help-desk/helpdesk.md + - Project support and Agile: 120-help-desk/help-desk-agile.md + - Help desk working practices: 120-help-desk/working-practices.md + - Project management: + - Project manager role: 070-project-management/pm-role.md + - Guidelines for starting a new project: 070-project-management/starting-new-project.md + - Invoicing: 070-project-management/invoicing.md + - Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md + - When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md + - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md + - Tracking contractual requirements: 070-project-management/contractual-requirements.md + - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md + - Time off request and approval process: 070-project-management/pto-request-approval-process.md + - Having the hard conversations: 070-project-management/hard-conversations.md + - Listserv setup: 070-project-management/listserv-setup.md + - Offboarding a team member from a project: 070-project-management/project-offboarding.md + - Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md + - Project calendar: 070-project-management/project-calendar.md + - Project folder structure: 070-project-management/project-folder.md + - Project Manager templates: 070-project-management/templates.md + - Project Manager training: 070-project-management/pm-training.md + - Project Management Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md + - Project Management Checklists: 070-project-management/project-management-checklists.md - About this guidebook: - - How and when to contribute to the guidebook: 000-contributing/README.md - - File structure: 000-contributing/file-structure.md - - Git workflow: 000-contributing/git-workflow.md - - GitHub actions: 000-contributing/github-actions.md - - Guidebook governance: 000-contributing/docs-governance.md - - Guidebook writing style: 000-contributing/writing-style-guide.md - - Markdown: 000-contributing/markdown.md - - License: LICENSE.md + - How and when to contribute to the guidebook: 000-contributing/README.md + - File structure: 000-contributing/file-structure.md + - Git workflow: 000-contributing/git-workflow.md + - GitHub actions: 000-contributing/github-actions.md + - Guidebook governance: 000-contributing/docs-governance.md + - Guidebook writing style: 000-contributing/writing-style-guide.md + - Markdown: 000-contributing/markdown.md + - License: LICENSE.md From 0859999167e6f53323625ac95e75df68b884cac3 Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Fri, 23 Dec 2022 15:24:06 -0800 Subject: [PATCH 16/20] Deleting nav items for pages that been deleted. Moved some pages around. --- mkdocs.yml | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 0be88e0e23..a60f284c79 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -143,26 +143,12 @@ nav: - Engineering: - Engineering calls: 060-engineering/README.md - Accessibility: 060-engineering/accessibility.md - - Backend development: 060-engineering/back-end-development.md - - Development and hosting environments: 060-engineering/dev-environments.md + - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md - Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md - Drupal developer tips for getting the most out of open source: 060-engineering/drupal-developer-tips-for-getting-the-most-out-of-open-source.md - - Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md - - Drupal site building: 060-engineering/drupal-site-building.md - - Engineer's role in client/team relationships: 060-engineering/engineer-role-in-client-relationships.md - - Engineering: 060-engineering/README.md - - Engineering project roles: 060-engineering/engineering-roles.md - Git: 060-engineering/git.md - - How to log internal meetings: 060-engineering/internalmeetings.md - - Quality assurance: 060-engineering/qa.md - Security and compliance: 060-engineering/security-compliance.md - - Systems and sandboxes: 060-engineering/systems-sandboxes.md - Tech Lead (TL) project role description: 060-engineering/tech-lead.md - - CSS (and SASS etc.): 060-engineering/front-end/css.md - - Development tools: 060-engineering/front-end/front-end-tools.md - - Drupal front-end development: 060-engineering/front-end/drupal-frontend.md - - Front-end development: 060-engineering/front-end/README.md - - Front-end testing: 060-engineering/front-end/testing.md - Help desk: - Help desk support: 120-help-desk/helpdesk.md - Project support and Agile: 120-help-desk/help-desk-agile.md @@ -189,7 +175,6 @@ nav: - Project Management Checklists: 070-project-management/project-management-checklists.md - About this guidebook: - How and when to contribute to the guidebook: 000-contributing/README.md - - File structure: 000-contributing/file-structure.md - Git workflow: 000-contributing/git-workflow.md - GitHub actions: 000-contributing/github-actions.md - Guidebook governance: 000-contributing/docs-governance.md From 156ae34b53c5f2c4774ceb72544137776496e3e0 Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Fri, 23 Dec 2022 15:50:05 -0800 Subject: [PATCH 17/20] Move as many files as possible out of the git root directory. --- .codespellrc | 2 -- .gitignore => .config/.gitignore | 5 ----- {lint => .config}/Dockerfile | 20 +++++++++++-------- {lint => .config}/action.yml | 4 ++-- .codespell-ignore => .config/codespell-ignore | 0 .config/codespellrc | 2 ++ mkdocs.yml => .config/mkdocs.yml | 1 + .../pre-commit-search-and-replace.yaml | 1 + {lint/config => .config/remark}/package.json | 0 .../remark}/remarkrc.problem | 0 .../remark}/remarkrc.suggestion | 0 .../remark}/retext.problem.js | 0 .../remark}/retext.suggestion.js | 0 {lint/config => .config/remark}/yarn.lock | 0 {lint => .config}/requirements.in | 0 {lint => .config}/requirements.txt | 0 {lint => .config/scripts}/mkdocs.sh | 2 +- {lint => .config/scripts}/remark.sh | 0 .github/workflows/codespell.yml | 2 +- .github/workflows/mkdocs.yml | 2 +- .github/workflows/reviewdog.yml | 2 +- .pre-commit-config.yaml | 4 ++++ .readthedocs.yaml | 4 ++-- 23 files changed, 28 insertions(+), 23 deletions(-) delete mode 100644 .codespellrc rename .gitignore => .config/.gitignore (50%) rename {lint => .config}/Dockerfile (55%) rename {lint => .config}/action.yml (67%) rename .codespell-ignore => .config/codespell-ignore (100%) create mode 100644 .config/codespellrc rename mkdocs.yml => .config/mkdocs.yml (99%) rename .pre-commit-search-and-replace.yaml => .config/pre-commit-search-and-replace.yaml (70%) rename {lint/config => .config/remark}/package.json (100%) rename {lint/config => .config/remark}/remarkrc.problem (100%) rename {lint/config => .config/remark}/remarkrc.suggestion (100%) rename {lint/config => .config/remark}/retext.problem.js (100%) rename {lint/config => .config/remark}/retext.suggestion.js (100%) rename {lint/config => .config/remark}/yarn.lock (100%) rename {lint => .config}/requirements.in (100%) rename {lint => .config}/requirements.txt (100%) rename {lint => .config/scripts}/mkdocs.sh (65%) rename {lint => .config/scripts}/remark.sh (100%) diff --git a/.codespellrc b/.codespellrc deleted file mode 100644 index 0d8b8bc2ad..0000000000 --- a/.codespellrc +++ /dev/null @@ -1,2 +0,0 @@ -[codespell] -ignore-words=.codespell-ignore diff --git a/.gitignore b/.config/.gitignore similarity index 50% rename from .gitignore rename to .config/.gitignore index 18360dd76d..22c18e9a85 100644 --- a/.gitignore +++ b/.config/.gitignore @@ -1,10 +1,5 @@ .*.swp .DS_Store -.bundle/ -*.html -.jekyll* -.sass-cache/ -_site/ node_modules output.log site diff --git a/lint/Dockerfile b/.config/Dockerfile similarity index 55% rename from lint/Dockerfile rename to .config/Dockerfile index 26d3efdd7f..0dbb796b31 100644 --- a/lint/Dockerfile +++ b/.config/Dockerfile @@ -1,9 +1,9 @@ +# This installs reviewdoc, mkdocs and remark for convenient usage in pre-commit hooks and Github actions. + FROM node:16-alpine ENV REVIEWDOG_VERSION=v0.13.1 -COPY requirements.txt /usr/src/ - RUN \ apk add --update \ ca-certificates \ @@ -13,19 +13,23 @@ RUN \ python3 \ python3-dev \ py3-pip \ - build-base && \ - pip3 install -r /usr/src/requirements.txt + build-base SHELL ["/bin/bash", "-o", "pipefail", "-c"] RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b /usr/local/bin/ ${REVIEWDOG_VERSION} -COPY *.sh /usr/bin/ +# Install mkdocs and dependencies. +COPY requirements.txt /usr/src/ +RUN pip3 install -r /usr/src/requirements.txt -COPY config/* /usr/src/ -RUN yarn install --production --non-interactive --cwd /usr/src/ && \ - yarn cache clean --force --cwd /usr/src/ \ +# Install remark and dependencies. +COPY remark/* /usr/src/ +RUN yarn install --production --non-interactive --cwd /usr/src && \ + yarn cache clean --force --cwd /usr/src \ mkdir /src ENV PATH="/usr/src/node_modules/.bin:${PATH}" + +COPY scripts/*.sh /usr/bin/ WORKDIR /src ENTRYPOINT ["/bin/bash"] diff --git a/lint/action.yml b/.config/action.yml similarity index 67% rename from lint/action.yml rename to .config/action.yml index 1bd22e4882..2d966c0b26 100644 --- a/lint/action.yml +++ b/.config/action.yml @@ -1,5 +1,5 @@ -name: "Run remark-lint with reviewdog" -description: "🐶 Run remark-lint with reviewdog on pull requests for documentation projects." +name: "Run repo specific lint tools" +description: "Runs repo specific lint tools on pull requests for documentation projects." author: "civicactions" inputs: github_token: diff --git a/.codespell-ignore b/.config/codespell-ignore similarity index 100% rename from .codespell-ignore rename to .config/codespell-ignore diff --git a/.config/codespellrc b/.config/codespellrc new file mode 100644 index 0000000000..d0ee1d42b6 --- /dev/null +++ b/.config/codespellrc @@ -0,0 +1,2 @@ +[codespell] +ignore-words=.config/codespell-ignore diff --git a/mkdocs.yml b/.config/mkdocs.yml similarity index 99% rename from mkdocs.yml rename to .config/mkdocs.yml index a60f284c79..c1608f38a8 100644 --- a/mkdocs.yml +++ b/.config/mkdocs.yml @@ -1,6 +1,7 @@ site_name: CivicActions Guidebook - Beta repo_url: https://github.com/CivicActions/handbook/ site_url: https://handbook.civicactions.com/en/latest/ +docs_dir: ../docs theme: name: material features: diff --git a/.pre-commit-search-and-replace.yaml b/.config/pre-commit-search-and-replace.yaml similarity index 70% rename from .pre-commit-search-and-replace.yaml rename to .config/pre-commit-search-and-replace.yaml index 02e6d43e12..ac7f5a4ade 100644 --- a/.pre-commit-search-and-replace.yaml +++ b/.config/pre-commit-search-and-replace.yaml @@ -1,3 +1,4 @@ +# These fix common "fancy" characters when pasting from word processors. - search: "´" replacement: "'" - search: "‘" diff --git a/lint/config/package.json b/.config/remark/package.json similarity index 100% rename from lint/config/package.json rename to .config/remark/package.json diff --git a/lint/config/remarkrc.problem b/.config/remark/remarkrc.problem similarity index 100% rename from lint/config/remarkrc.problem rename to .config/remark/remarkrc.problem diff --git a/lint/config/remarkrc.suggestion b/.config/remark/remarkrc.suggestion similarity index 100% rename from lint/config/remarkrc.suggestion rename to .config/remark/remarkrc.suggestion diff --git a/lint/config/retext.problem.js b/.config/remark/retext.problem.js similarity index 100% rename from lint/config/retext.problem.js rename to .config/remark/retext.problem.js diff --git a/lint/config/retext.suggestion.js b/.config/remark/retext.suggestion.js similarity index 100% rename from lint/config/retext.suggestion.js rename to .config/remark/retext.suggestion.js diff --git a/lint/config/yarn.lock b/.config/remark/yarn.lock similarity index 100% rename from lint/config/yarn.lock rename to .config/remark/yarn.lock diff --git a/lint/requirements.in b/.config/requirements.in similarity index 100% rename from lint/requirements.in rename to .config/requirements.in diff --git a/lint/requirements.txt b/.config/requirements.txt similarity index 100% rename from lint/requirements.txt rename to .config/requirements.txt diff --git a/lint/mkdocs.sh b/.config/scripts/mkdocs.sh similarity index 65% rename from lint/mkdocs.sh rename to .config/scripts/mkdocs.sh index a9a473003f..240421f459 100644 --- a/lint/mkdocs.sh +++ b/.config/scripts/mkdocs.sh @@ -5,6 +5,6 @@ set -euo pipefail # Exclude info log messages for more concise output. tmp_dir=$(mktemp -d -t mkdocs-XXXXXX) -/usr/bin/mkdocs build --strict --site-dir "${tmp_dir}" 2>&1 | { grep -v '^INFO' || true; } +/usr/bin/mkdocs build --config-file=.config/mkdocs.yml --strict --site-dir "${tmp_dir}" 2>&1 | { grep -v '^INFO' || true; } rm -rf "${tmp_dir}" echo "mkdocs build successful" diff --git a/lint/remark.sh b/.config/scripts/remark.sh similarity index 100% rename from lint/remark.sh rename to .config/scripts/remark.sh diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index b2362f598c..33a7c83ee1 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -12,4 +12,4 @@ jobs: - uses: codespell-project/actions-codespell@master with: path: docs - ignore_words_file: .codespell-ignore + config: .config/codespellrc diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index c89fe911a8..5442acccf2 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -12,7 +12,7 @@ jobs: with: fetch-depth: 0 - name: Run mkdocs to check build. - uses: ./lint + uses: .config with: github_token: ${{ secrets.GITHUB_TOKEN }} command: mkdocs.sh diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml index 0a6b2d8108..6051b9a20c 100644 --- a/.github/workflows/reviewdog.yml +++ b/.github/workflows/reviewdog.yml @@ -11,7 +11,7 @@ jobs: with: fetch-depth: 0 - name: Run remark-lint with reviewdog for documentation projects. - uses: ./lint + uses: .config with: github_token: ${{ secrets.GITHUB_TOKEN }} command: remark.sh diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0430be608e..be5784ffe1 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -34,11 +34,15 @@ repos: hooks: - id: search-and-replace files: docs + args: + - "--config=.config/pre-commit-search-and-replace.yaml" - repo: https://github.com/codespell-project/codespell rev: v2.2.2 hooks: - id: codespell files: docs + args: + - "--config=.config/codespellrc" - repo: https://github.com/pre-commit/mirrors-prettier rev: v3.0.0-alpha.4 hooks: diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6818cc941e..9dccc22f25 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,9 +12,9 @@ build: python: "3.9" mkdocs: - configuration: mkdocs.yml + configuration: .config/mkdocs.yml # Optionally declare the Python requirements required to build your docs python: install: - - requirements: lint/requirements.txt + - requirements: .config/requirements.txt From 9db1a85c2c3a76b9ac5b07c19fc31febac2c0202 Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Fri, 23 Dec 2022 15:53:11 -0800 Subject: [PATCH 18/20] Add trailing slash to try and convince Github this is a path. --- .github/workflows/mkdocs.yml | 2 +- .github/workflows/reviewdog.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 5442acccf2..0e388de430 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -12,7 +12,7 @@ jobs: with: fetch-depth: 0 - name: Run mkdocs to check build. - uses: .config + uses: .config/ with: github_token: ${{ secrets.GITHUB_TOKEN }} command: mkdocs.sh diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml index 6051b9a20c..f3efadaa22 100644 --- a/.github/workflows/reviewdog.yml +++ b/.github/workflows/reviewdog.yml @@ -11,7 +11,7 @@ jobs: with: fetch-depth: 0 - name: Run remark-lint with reviewdog for documentation projects. - uses: .config + uses: .config/ with: github_token: ${{ secrets.GITHUB_TOKEN }} command: remark.sh From 0b1b13ad78a3a873380e361893e43a2ce5f069c7 Mon Sep 17 00:00:00 2001 From: Owen Barton Date: Fri, 23 Dec 2022 15:55:44 -0800 Subject: [PATCH 19/20] Try adding leading . also. --- .github/workflows/mkdocs.yml | 2 +- .github/workflows/reviewdog.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 0e388de430..672d8c1598 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -12,7 +12,7 @@ jobs: with: fetch-depth: 0 - name: Run mkdocs to check build. - uses: .config/ + uses: ./.config/ with: github_token: ${{ secrets.GITHUB_TOKEN }} command: mkdocs.sh diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml index f3efadaa22..4aeefb2fec 100644 --- a/.github/workflows/reviewdog.yml +++ b/.github/workflows/reviewdog.yml @@ -11,7 +11,7 @@ jobs: with: fetch-depth: 0 - name: Run remark-lint with reviewdog for documentation projects. - uses: .config/ + uses: ./.config/ with: github_token: ${{ secrets.GITHUB_TOKEN }} command: remark.sh From dd65cdf406772959aa4abf7083916c0d2a3fbd4f Mon Sep 17 00:00:00 2001 From: Daniel Mundra Date: Tue, 27 Dec 2022 14:04:43 -0800 Subject: [PATCH 20/20] Updated leave request menu item. --- .config/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/mkdocs.yml b/.config/mkdocs.yml index c1608f38a8..6ffbf49ae3 100644 --- a/.config/mkdocs.yml +++ b/.config/mkdocs.yml @@ -163,7 +163,7 @@ nav: - Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md - Tracking contractual requirements: 070-project-management/contractual-requirements.md - Conflict resolution and growth mindset: 070-project-management/growth-mindset.md - - Time off request and approval process: 070-project-management/pto-request-approval-process.md + - Leave Requests and Stepping Away: 070-project-management/leave-requests-and-stepping-away.md - Having the hard conversations: 070-project-management/hard-conversations.md - Listserv setup: 070-project-management/listserv-setup.md - Offboarding a team member from a project: 070-project-management/project-offboarding.md