Skip to content

Commit b57dd23

Browse files
dmundragrugnogpre-commit-ci[bot]ContentBrewmaster
authored
Material theme beta (#973)
* Add basic material theme config. * Switch workflow to use lint action, rather than latest container. * Update check name and add log message. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add missing remark command. * Setting the navigation features for tabs and expansion. * 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> * 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> * Added jquery for the read the docs flyout menu. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Updated CSS for rst-versions. * Commenting out nav expand and adding nav indexes. * 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 <[email protected]> * Added comments and adjusteds indentation of the menu items (switched to 2 spaces identation). * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Deleting nav items for pages that been deleted. Moved some pages around. * Move as many files as possible out of the git root directory. * Add trailing slash to try and convince Github this is a path. * Try adding leading . also. * Updated leave request menu item. Co-authored-by: Owen Barton <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Denise Eisner <[email protected]>
1 parent 8cb2d42 commit b57dd23

30 files changed

+365
-143
lines changed

‎.codespellrc

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎.gitignore renamed to ‎.config/.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
.*.swp
22
.DS_Store
3-
.bundle/
4-
*.html
5-
.jekyll*
6-
.sass-cache/
7-
_site/
83
node_modules
94
output.log
105
site

‎.config/Dockerfile

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# This installs reviewdoc, mkdocs and remark for convenient usage in pre-commit hooks and Github actions.
2+
3+
FROM node:16-alpine
4+
5+
ENV REVIEWDOG_VERSION=v0.13.1
6+
7+
RUN \
8+
apk add --update \
9+
ca-certificates \
10+
bash \
11+
git \
12+
openssh \
13+
python3 \
14+
python3-dev \
15+
py3-pip \
16+
build-base
17+
18+
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
19+
RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b /usr/local/bin/ ${REVIEWDOG_VERSION}
20+
21+
# Install mkdocs and dependencies.
22+
COPY requirements.txt /usr/src/
23+
RUN pip3 install -r /usr/src/requirements.txt
24+
25+
# Install remark and dependencies.
26+
COPY remark/* /usr/src/
27+
RUN yarn install --production --non-interactive --cwd /usr/src && \
28+
yarn cache clean --force --cwd /usr/src \
29+
mkdir /src
30+
ENV PATH="/usr/src/node_modules/.bin:${PATH}"
31+
32+
COPY scripts/*.sh /usr/bin/
33+
WORKDIR /src
34+
35+
ENTRYPOINT ["/bin/bash"]
36+
CMD []

‎.config/action.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: "Run repo specific lint tools"
2+
description: "Runs repo specific lint tools on pull requests for documentation projects."
3+
author: "civicactions"
4+
inputs:
5+
github_token:
6+
description: "GITHUB_TOKEN."
7+
required: true
8+
default: ${{ github.token }}
9+
command:
10+
description: "Command to run"
11+
required: true
12+
runs:
13+
using: "docker"
14+
image: "Dockerfile"
15+
args:
16+
- ${{ inputs.command }}

‎.codespell-ignore renamed to ‎.config/codespell-ignore

File renamed without changes.

‎.config/codespellrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[codespell]
2+
ignore-words=.config/codespell-ignore

‎.config/mkdocs.yml

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
site_name: CivicActions Guidebook - Beta
2+
repo_url: https://github.com/CivicActions/handbook/
3+
site_url: https://handbook.civicactions.com/en/latest/
4+
docs_dir: ../docs
5+
theme:
6+
name: material
7+
features:
8+
- navigation.tabs
9+
- navigation.indexes
10+
#- navigation.expand
11+
favicon: img/favicon.ico
12+
logo: img/ca-logo-white.svg
13+
palette:
14+
# Palette toggle for light mode
15+
- scheme: default
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
# Palette toggle for dark mode
20+
- scheme: slate
21+
toggle:
22+
icon: material/brightness-4
23+
name: Switch to light mode
24+
markdown_extensions:
25+
- toc:
26+
title: On this page
27+
plugins:
28+
- search
29+
extra_css:
30+
- css/extra.css
31+
extra_javascript:
32+
#- js/extra.js
33+
# Read the Docs requires JQuery for its JavaScript code to inject the flyout
34+
# menu. Material for MkDocs does not come with JQuery.
35+
- "https://code.jquery.com/jquery-3.6.2.min.js"
36+
# Navigation of the entire site is managed below, both the main menu items and their child pages.
37+
nav:
38+
- Home: index.md
39+
- About CivicActions:
40+
- Mission and values: 020-about-us/mission-values.md
41+
- Culture: 020-about-us/culture.md
42+
- Diversity, Equity, Inclusion, and Accessibility (DEIA):
43+
- DEIA at CivicActions: 050-how-we-work/diversity-equity-inclusion/purpose.md
44+
- Defining DEIA: 050-how-we-work/diversity-equity-inclusion/defining-dei.md
45+
- Affinity channels: 050-how-we-work/diversity-equity-inclusion/affinity-channels.md
46+
- DEIA - Get involved: 050-how-we-work/diversity-equity-inclusion/deia-get-involved.md
47+
- Resources: 050-how-we-work/diversity-equity-inclusion/resources.md
48+
- Our structure:
49+
- Departments, projects, practice areas, and pods: 050-how-we-work/organization.md
50+
- Organizational structure: 020-about-us/org-structure.md
51+
- Management team: 050-how-we-work/management-ops.md
52+
- Background and history: 020-about-us/background-and-history.md
53+
- Our annual summit: 030-policies/annual-retreat.md
54+
- Employee benefits:
55+
- Benefits policy (US employees): 040-employee-handbook-us/benefits-and-holidays.md
56+
- Compensation (US employees): 040-employee-handbook-us/compensation.md
57+
- Technology stipend policy (US employees): 040-employee-handbook-us/tech-stipend.md
58+
- Benefits policy (Canadian employees): 045-employee-handbook-ca/benefits-and-holidays.md
59+
- Technology stipend (Canadian employees): 045-employee-handbook-ca/tech-stipend.md
60+
- Professional development: 030-policies/prodev.md
61+
- Employee referral bonus program: 030-policies/employee-referral-bonus.md
62+
- On-call stipends: 030-policies/on-call-stipend.md
63+
- Company policies:
64+
- Expenses: 030-policies/expenses.md
65+
- Travel expenses and billing: 030-policies/travel-101.md
66+
- Timesheets (Unanet): 050-how-we-work/tools/unanet.md
67+
- Security Policy: 030-policies/security.md
68+
- Employment policies (US employees):
69+
- Employment: 040-employee-handbook-us/employment.md
70+
- Introductory period: 040-employee-handbook-us/introductory-period.md
71+
- Anti-harassment: 040-employee-handbook-us/anti-harassment-policies.md
72+
- Covid 19 safety: 040-employee-handbook-us/covid19safety.md
73+
- Code of conduct: 030-policies/code-of-conduct.md
74+
- Workplace guidelines: 030-policies/workplace-guidelines.md
75+
- Annual performance review: 030-policies/annual-review-process.md
76+
- Performance management: 030-policies/performance-management.md
77+
- Leaving Civicactions: 030-policies/leaving-civicactions.md
78+
- Health, Safety and Security Policy: 030-policies/health-safety-security.md
79+
- New hire orientation:
80+
- Welcome to CivicActions!: 010-welcome-to-civicactions/welcome.md
81+
- Buddy program: 010-welcome-to-civicactions/training/buddy-program.md
82+
- Elevator pitch: 020-about-us/elevator-pitch.md
83+
- Free and open source software (FOSS): 010-welcome-to-civicactions/training/intro-open-source.md
84+
- Meetings and meeting tools: 010-welcome-to-civicactions/training/meetings-and-meeting-tools.md
85+
- People planning: 010-welcome-to-civicactions/training/people-planning.md
86+
- Security for everyone: 010-welcome-to-civicactions/training/security-training.md
87+
- Training resources: 050-how-we-work/training-resources.md
88+
- Video call best practices: 050-how-we-work/video-call-best-practices.md
89+
- Virtual workplace basics: 050-how-we-work/virtual-workplace-basics.md
90+
- Common practices and tools:
91+
- Agile:
92+
- Agile overview: 050-how-we-work/agile-overview.md
93+
- Agile practice: 050-how-we-work/agile-practices/README.md
94+
- Backlog refinement: 050-how-we-work/agile-practices/backlog-refinement.md
95+
- Daily scrum calls: 050-how-we-work/agile-practices/daily-scrum-calls.md
96+
- How to create tickets: 050-how-we-work/tools/tickets-cards.md
97+
- Sprint cycle: 050-how-we-work/agile-practices/sprint-cycle.md
98+
- Sprint demo: 050-how-we-work/agile-practices/sprint-demo.md
99+
- Sprint planning meetings: 050-how-we-work/agile-practices/sprint-planning-meetings.md
100+
- Sprint retrospectives: 050-how-we-work/agile-practices/sprint-retrospectives.md
101+
- Balance scores: 050-how-we-work/balance-scores.md
102+
- Gold Star Program: 050-how-we-work/gold-star-program.md
103+
- Security awareness and tools:
104+
- Awareness and tools: 100-security/awareness.md
105+
- Setting up and using Yubikey:
106+
- 100-security/yubikey/README.md
107+
- Yubikey and Linux: 100-security/yubikey/linux.md
108+
- Yubikey and Mac OS: 100-security/yubikey/macosx.md
109+
- Drupal RMF support: 100-security/drupal-rmf-support.md
110+
- Encryption: 100-security/encryption.md
111+
- Incidents:
112+
- Contingency plan: 100-security/contingency-plan.md
113+
- Incident response checklist: 100-security/incident-response-checklist.md
114+
- Incident response plan: 100-security/incident-response-plan.md
115+
- Security incidents: 100-security/incidents.md
116+
- Skills Base: 050-how-we-work/tools/skills-base.md
117+
- Software and support:
118+
- Internal technical support: 050-how-we-work/support.md
119+
- Bookmarks: 050-how-we-work/bookmarks.md
120+
- Email: 050-how-we-work/tools/email.md
121+
- General contacts and listservs: 020-about-us/general-contacts-and-listservs.md
122+
- Github: 050-how-we-work/tools/github.md
123+
- Google Calendar: 050-how-we-work/tools/google-calendar.md
124+
- Google Docs: 050-how-we-work/tools/google-docs.md
125+
- Google Meet: 050-how-we-work/tools/google-hangouts.md
126+
- Jira: 050-how-we-work/tools/jira.md
127+
- Markdown: 050-how-we-work/tools/markdown.md
128+
- Slack: 050-how-we-work/tools/slack.md
129+
- Text editors: 050-how-we-work/tools/text-editors.md
130+
- Trello: 050-how-we-work/tools/trello.md
131+
- Zoom: 050-how-we-work/tools/zoom.md
132+
- Telephone use: 050-how-we-work/tools/telephone.md
133+
- Practice areas:
134+
- About practice areas: 050-how-we-work/practice-areas/README.md
135+
- Accessibility practice area: 050-how-we-work/practice-areas/accessibility-practice-area.md
136+
- Design and research:
137+
- Audience and outcomes guide: 110-ux/services/research/audiences-and-outcomes-guide.md
138+
- Content audit guide: 110-ux/services/research/content-audit-guide.md
139+
- Content modeling guide: 110-ux/services/design/content-modeling-guide.md
140+
- Stakeholder interviews guide: 110-ux/services/research/stakeholder-interviews-guide.md
141+
- Story mapping guide: 110-ux/services/research/story-mapping-guide.md
142+
- Usability testing guide: 110-ux/services/research/usability-testing-guide.md
143+
- User personas guide: 110-ux/services/research/user-personas-guide.md
144+
- Engineering:
145+
- Engineering calls: 060-engineering/README.md
146+
- Accessibility: 060-engineering/accessibility.md
147+
- Drupal practice area: 050-how-we-work/practice-areas/drupal-practice-area.md
148+
- Drupal - contributed vs. custom development: 060-engineering/most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md
149+
- 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
150+
- Git: 060-engineering/git.md
151+
- Security and compliance: 060-engineering/security-compliance.md
152+
- Tech Lead (TL) project role description: 060-engineering/tech-lead.md
153+
- Help desk:
154+
- Help desk support: 120-help-desk/helpdesk.md
155+
- Project support and Agile: 120-help-desk/help-desk-agile.md
156+
- Help desk working practices: 120-help-desk/working-practices.md
157+
- Project management:
158+
- Project manager role: 070-project-management/pm-role.md
159+
- Guidelines for starting a new project: 070-project-management/starting-new-project.md
160+
- Invoicing: 070-project-management/invoicing.md
161+
- Onboarding a new project team member: 070-project-management/onboarding-new-project-team-member.md
162+
- When your project gets a contractual Modification (MOD) or Extension: 070-project-management/mods-and-extentions.md
163+
- Tracking contract expirations and renewals: 070-project-management/contract-expiration-tracking.md
164+
- Tracking contractual requirements: 070-project-management/contractual-requirements.md
165+
- Conflict resolution and growth mindset: 070-project-management/growth-mindset.md
166+
- Leave Requests and Stepping Away: 070-project-management/leave-requests-and-stepping-away.md
167+
- Having the hard conversations: 070-project-management/hard-conversations.md
168+
- Listserv setup: 070-project-management/listserv-setup.md
169+
- Offboarding a team member from a project: 070-project-management/project-offboarding.md
170+
- Planning travel and onsite meetings: 070-project-management/planning-onsite-meetings.md
171+
- Project calendar: 070-project-management/project-calendar.md
172+
- Project folder structure: 070-project-management/project-folder.md
173+
- Project Manager templates: 070-project-management/templates.md
174+
- Project Manager training: 070-project-management/pm-training.md
175+
- Project Management Unanet Tasks and Training Material: 070-project-management/pm-unanet-tasks.md
176+
- Project Management Checklists: 070-project-management/project-management-checklists.md
177+
- About this guidebook:
178+
- How and when to contribute to the guidebook: 000-contributing/README.md
179+
- Git workflow: 000-contributing/git-workflow.md
180+
- GitHub actions: 000-contributing/github-actions.md
181+
- Guidebook governance: 000-contributing/docs-governance.md
182+
- Guidebook writing style: 000-contributing/writing-style-guide.md
183+
- Markdown: 000-contributing/markdown.md
184+
- License: LICENSE.md

‎.pre-commit-search-and-replace.yaml renamed to ‎.config/pre-commit-search-and-replace.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# These fix common "fancy" characters when pasting from word processors.
12
- search: "´"
23
replacement: "'"
34
- search: "‘"

‎lint/config/package.json renamed to ‎.config/remark/package.json

File renamed without changes.

‎lint/config/remarkrc.problem renamed to ‎.config/remark/remarkrc.problem

File renamed without changes.

‎lint/config/remarkrc.suggestion renamed to ‎.config/remark/remarkrc.suggestion

File renamed without changes.

‎lint/config/retext.problem.js renamed to ‎.config/remark/retext.problem.js

File renamed without changes.

‎lint/config/retext.suggestion.js renamed to ‎.config/remark/retext.suggestion.js

File renamed without changes.

‎lint/config/yarn.lock renamed to ‎.config/remark/yarn.lock

File renamed without changes.

‎.config/requirements.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mkdocs_material==8.5.11

‎.config/requirements.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
#
2+
# This file is autogenerated by pip-compile with python 3.10
3+
# To update, run:
4+
#
5+
# pip-compile requirements.in
6+
#
7+
certifi==2022.12.7
8+
# via requests
9+
charset-normalizer==2.1.1
10+
# via requests
11+
click==8.1.3
12+
# via mkdocs
13+
ghp-import==2.1.0
14+
# via mkdocs
15+
idna==3.4
16+
# via requests
17+
jinja2==3.1.2
18+
# via
19+
# mkdocs
20+
# mkdocs-material
21+
markdown==3.3.7
22+
# via
23+
# mkdocs
24+
# mkdocs-material
25+
# pymdown-extensions
26+
markupsafe==2.1.1
27+
# via jinja2
28+
mergedeep==1.3.4
29+
# via mkdocs
30+
mkdocs==1.4.2
31+
# via mkdocs-material
32+
mkdocs-material==8.5.11
33+
# via -r requirements.in
34+
mkdocs-material-extensions==1.1.1
35+
# via mkdocs-material
36+
packaging==21.3
37+
# via mkdocs
38+
pygments==2.13.0
39+
# via mkdocs-material
40+
pymdown-extensions==9.9
41+
# via mkdocs-material
42+
pyparsing==3.0.9
43+
# via packaging
44+
python-dateutil==2.8.2
45+
# via ghp-import
46+
pyyaml==6.0
47+
# via
48+
# mkdocs
49+
# pyyaml-env-tag
50+
pyyaml-env-tag==0.1
51+
# via mkdocs
52+
requests==2.28.1
53+
# via mkdocs-material
54+
six==1.16.0
55+
# via python-dateutil
56+
urllib3==1.26.13
57+
# via requests
58+
watchdog==2.2.0
59+
# via mkdocs

‎lint/mkdocs.sh renamed to ‎.config/scripts/mkdocs.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ set -euo pipefail
55
# Exclude info log messages for more concise output.
66

77
tmp_dir=$(mktemp -d -t mkdocs-XXXXXX)
8-
/usr/bin/mkdocs build --strict --site-dir "${tmp_dir}" 2>&1 | { grep -v '^INFO' || true; }
8+
/usr/bin/mkdocs build --config-file=.config/mkdocs.yml --strict --site-dir "${tmp_dir}" 2>&1 | { grep -v '^INFO' || true; }
99
rm -rf "${tmp_dir}"
10+
echo "mkdocs build successful"

‎lint/remark.sh renamed to ‎.config/scripts/remark.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ MASTER=master
1212
if [[ -z ${LOCAL_MASTER} ]]; then
1313
MASTER=origin/master
1414
fi
15-
# Only check paths changed on branch to avoid excessive output.
16-
export REMARK_PATHS=$(git diff --diff-filter=AM --name-only "${MASTER}" | grep '^docs')
15+
# Only check paths changed on branch to avoid excessive output. Exclude CSS.
16+
export REMARK_PATHS=$(git diff --diff-filter=AM --name-only "${MASTER}" ':!docs/css/extra.css' | grep '^docs')
1717

1818
if [[ -n "${INPUT_GITHUB_TOKEN:-}" ]]; then
1919
export REVIEWDOG_GITHUB_API_TOKEN="${INPUT_GITHUB_TOKEN}"

‎.github/workflows/codespell.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ jobs:
1212
- uses: codespell-project/actions-codespell@master
1313
with:
1414
path: docs
15-
ignore_words_file: .codespell-ignore
15+
config: .config/codespellrc

‎.github/workflows/mkdocs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ jobs:
88
mkdocs:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/checkout@v2
12-
- name: Run mkdocs
13-
uses: docker://civicactions/handbook-lint:latest
11+
- uses: actions/checkout@v1
1412
with:
15-
entrypoint: /bin/bash
16-
args: mkdocs.sh
13+
fetch-depth: 0
14+
- name: Run mkdocs to check build.
15+
uses: ./.config/
16+
with:
17+
github_token: ${{ secrets.GITHUB_TOKEN }}
18+
command: mkdocs.sh

‎.github/workflows/reviewdog.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ jobs:
1111
with:
1212
fetch-depth: 0
1313
- name: Run remark-lint with reviewdog for documentation projects.
14-
uses: ./lint
14+
uses: ./.config/
1515
with:
1616
github_token: ${{ secrets.GITHUB_TOKEN }}
17+
command: remark.sh

‎.pre-commit-config.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,15 @@ repos:
3434
hooks:
3535
- id: search-and-replace
3636
files: docs
37+
args:
38+
- "--config=.config/pre-commit-search-and-replace.yaml"
3739
- repo: https://github.com/codespell-project/codespell
3840
rev: v2.2.2
3941
hooks:
4042
- id: codespell
4143
files: docs
44+
args:
45+
- "--config=.config/codespellrc"
4246
- repo: https://github.com/pre-commit/mirrors-prettier
4347
rev: v3.0.0-alpha.4
4448
hooks:

0 commit comments

Comments
 (0)