-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentation.html
459 lines (280 loc) · 15.3 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>How to work on the Accessibility site | CivicActions Accessibility</title>
<link rel="shortcut icon" type="image/ico"
href="/assets/img/logos/civicaction-square.ico">
<!-- Facebook OG and Twitter Card -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@civicactions" />
<meta name="twitter:title" content="How to work on the Accessibility site">
<meta name="twitter:creator" content="@civicactions" />
<meta name="twitter:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/general-a11y.png">
<meta name="twitter:image:alt" content="CivicActions Accessibility">
<meta name="twitter:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/playbook.png">
<meta name="twitter:image:alt" content="CivicActions Accessibility Playbook">
<meta name="twitter:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/tip-of-the-week.png">
<meta name="twitter:image:alt" content="CivicActions Accessibility Tip of the Week">
<meta property="og:url" content="https://accessibility-qa.civicactions.com/" />
<meta property="og:title" content="CivicActions-Accessibility" />
<meta property="og:description" content="CivicActions Accessibility site is an open project for our team members and those who work for digital inclusion." />
<meta property="og:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/general-a11y.png" />
<meta property="og:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/playbook.png" />
<meta property="og:image" content="https://accessibility-qa.civicactions.com/assets/img/thumbnail-images/tip-of-the-week.png" />
<!-- Font Awesome -->
<!-- This is code the Font Awesome CDN generates for me that doesn't work -->
<script src="https://use.fontawesome.com/4fe5bba9d1.js"></script>
<link rel="stylesheet" href="https://use.fontawesome.com/7207a55a98.css">
<!-- This is code from DistributedGov that works -->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.8.2/css/all.css" integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- Google Fonts -->
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Nunito&family=Work+Sans&display=swap" rel="stylesheet">
<link rel="stylesheet"
href="/assets/css/uswds-theme.css"
media="screen">
</head>
<body class=" ">
<a class="usa-skipnav" href="#main-content">Skip to main content</a>
<!---->
<div class="usa-overlay"></div>
<header class="usa-header usa-header--extended"><div class="usa-navbar">
<div class="usa-logo" id="extended-logo">
<em class="usa-logo__text"><a href="/" title="Home" aria-label="Home">
<img class="ca-logo" src="/assets/img/ca-logo.png" alt="civicactions logo">
<p class="site-name-logo">Accessibility</p> <sup>ALPHA</sup></a></em>
</div>
<button class="usa-menu-btn">Menu</button>
</div>
<nav aria-label="Primary navigation" class="usa-nav">
<div class="usa-nav__inner"><button class="usa-nav__close"><img src="/assets/uswds/img/close.svg" role="img" alt="close"></button>
<ul class="usa-nav__primary usa-accordion"><li class="usa-nav__primary-item">
<button class="usa-accordion__button usa-nav__link " aria-expanded="false" aria-controls="extended-nav-section-one"><span>About</span></button>
<ul id="extended-nav-section-one" class="usa-nav__submenu" hidden><li class="usa-nav__submenu-item">
<a href="/about/" class="">Who we are</a>
</li><li class="usa-nav__submenu-item">
<a href="/about/people/" class="">Meet us</a>
</li><li class="usa-nav__submenu-item">
<a href="/about/contact" class="">Contact us</a>
</li><li class="usa-nav__submenu-item">
<a href="/about/join" class="">Join us</a>
</li></ul></li>
<li class="usa-nav__primary-item">
<a class="usa-nav__link " href="/calendar"><span>Calendar</span></a>
</li>
<li class="usa-nav__primary-item">
<a class="usa-nav__link " href="/news/"><span>News</span></a>
</li>
<li class="usa-nav__primary-item">
<a class="usa-nav__link " href="/playbook/"><span>Playbook</span></a>
</li>
<li class="usa-nav__primary-item">
<a class="usa-nav__link " href="/guide/"><span>Guide</span></a>
</li>
<li class="usa-nav__primary-item">
<a class="usa-nav__link " href="/search"><span>Search</span></a>
</li>
</ul>
<div class="usa-nav__secondary">
<ul class="usa-nav__secondary-links"><li class="usa-nav__secondary-item">
<a href="https://civicactions.com/">CivicActions.com</a>
</li></ul>
</div>
</div>
</nav>
</header>
<aside>
</aside>
<main id="main-content" class="usa-layout-docs usa-layout-docs__main desktop:grid-col-9 usa-prose">
<div id="breadcrumbs" class="grid-container">
<nav class="usa-breadcrumb" aria-label="Breadcrumbs">
<ol class="usa-breadcrumb__list">
<li class="usa-breadcrumb__list-item">
<a href="/" class="usa-breadcrumb__link">Home</a>
</li>
<li class="usa-breadcrumb__list-item usa-current" aria-current="page">
How to work on the Accessibility site
</li>
</ol>
</nav>
</div>
<div class="usa-section">
<div class="grid-container">
<div class="grid-row grid-gap flex-align-start">
<div class="usa-layout-docs usa-layout-docs__main usa-prose">
<h1>How to work on the Accessibility site</h1>
<!-- content -->
<p>The site is using the <a href="https://designsystem.digital.gov/">USWDS theme</a> built with <a href="https://jekyllrb.com/">Jekyll</a>.</p>
<h2 id="how-we-work">How we work</h2>
<p>We as a team have created a <a href="https://github.com/CivicActions/accessibility/projects/1">board</a> where we can collaborate our work. Here we can track what work is in the backlog or in progress.</p>
<p>Email <a href="mailto:accessibility-qa.civicactions.com">accessibility-qa.civicactions.com</a> or message in slack #accessibility for access to the <a href="https://github.com/CivicActions/accessibility">GitHub repo</a>
Once added to the GitHub repo, if you find any issues, spelling mistake, or an idea you think should be added to the site, create an issue.</p>
<h2 id="create-an-issue">Create an issue</h2>
<ol>
<li>Visit <a href="https://github.com/CivicActions/accessibility/issues/new/choose">create an issue page</a></li>
<li>Choose the type of issue
<ul>
<li>Add new team member to repo</li>
<li>Bug report</li>
<li>Feature request</li>
<li>General issue</li>
<li>Retrospective</li>
</ul>
</li>
<li>Add a title and a description and click submit</li>
</ol>
<p>The ticket will be added to the backlog column on the <a href="https://github.com/CivicActions/accessibility/projects/1">board</a></p>
<h2 id="working-on-an-issue">Working on an issue</h2>
<p>All tickets should be kept in the backlog. Tickets in To-do column are added by a team member who is committing to working on this ticket in the current week.
When working on a ticket, the ticket should be moved to the In-progress column on the <a href="https://github.com/CivicActions/accessibility/projects/1">board</a></p>
<h2 id="how-to-add-content">How to add content</h2>
<p>To create a page with content, can be done directly in GitHub.
The repo has been set up for different sections</p>
<ul>
<li>About</li>
<li>Calendar</li>
<li>News</li>
<li>Playbook (how tos)</li>
<li>Guide (resources)</li>
</ul>
<p>To add a page with no section click <a href="https://github.com/CivicActions/accessibility/new/main/pages">Add file</a></p>
<p>To add a page under a section when creating a new file in the <a href="https://github.com/CivicActions/accessibility">main repo</a></p>
<ol>
<li>Click on the directory of the section your page will live.</li>
<li>Click Add file.</li>
</ol>
<p>Learn how to use <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">markdown</a> to create structured content.</p>
<h2 id="how-to-set-up-a-local-environment">How to set up a local environment</h2>
<ol>
<li>git clone [email protected]:CivicActions/accessibility.git</li>
<li>cd accessibility</li>
<li>bundle install</li>
<li>bundle exec jekyll serve -> this will continue to run while in development.</li>
</ol>
<h2 id="creating-a-pull-request">Creating a pull request</h2>
<ol>
<li>git checkout -b your-name/issue-number</li>
<li>git add files</li>
<li>git push origin your-name/issue-number</li>
</ol>
<p>A member with permissions to approve the merge of the pull request will review and merge your work.</p>
</div>
</div>
</div>
</div>
</main>
<footer class="usa-footer usa-footer--big">
<div class="grid-container">
<p>
<a href="https://github.com/civicactions/accessibility/edit/main/docs/documentation.md" class="usa-sidenav-edit" target="_blank">Help improve this page</a>
<!-- // Date not working
· Last updated: March 18, 2025 at 05:33 PM
-->
</p>
</div>
<div class="grid-container usa-footer__return-to-top">
<a href="#">Return to top</a>
</div>
<div class="usa-footer__primary-section">
<div class="grid-container">
<div class="grid-row grid-gap">
<div class="">
<nav class="usa-footer__nav" aria-label="Footer navigation">
<div class="grid-row grid-gap-4">
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/contact">
Contact
</a>
</section>
</div>
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/conduct">
Conduct
</a>
</section>
</div>
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/license">
License
</a>
</section>
</div>
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/colophon">
Colophon
</a>
</section>
</div>
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/analytics">
Analytics
</a>
</section>
</div>
<div class="mobile-lg:grid-col-6 desktop:grid-col-4">
<section class="usa-footer__primary-content usa-footer__primary-content--collapsible">
<a class="usa-footer__primary-link" href="/accessibility">
Accessibility
</a>
</section>
</div>
</div>
</nav>
</div>
</div>
</div>
</div>
<div class="usa-footer__secondary-section">
<div class="grid-container">
<div class="grid-row grid-gap">
<div class="usa-footer__logo grid-row mobile-lg:grid-col-6 mobile-lg:grid-gap-2">
<div class="mobile-lg:grid-col-auto">
<h2 class="usa-footer__logo-heading">CivicActions Accessibility</h2>
</div>
</div>
<div class="usa-footer__contact-links mobile-lg:grid-col-6">
<div class="usa-footer__social-links grid-row grid-gap-1">
<div class="grid-col-auto">
<a class="usa-social-link usa-social-link--github" href="https://github.com/civicactions/accessibility">
<span>GitHub</span>
</a>
<a class="usa-social-link usa-social-link--facebook" href="https://facebook.com/civicactions">
<span>Facebook</span>
</a>
<a class="usa-social-link usa-social-link--twitter" href="https://twitter.com/civicactions">
<span>Twitter</span>
</a>
<a class="usa-social-link usa-social-link--linkedin" href="https://www.linkedin.com/company/civicactions/">
<span>LinkedIn</span>
</a>
<a class="usa-social-link usa-social-link--rss" href="https://accessibility-qa.civicactions.com/feed.xml">
<span>RSS</span>
</a>
</div>
</div>
<address class="usa-footer__address">
<div class="usa-footer__contact-info grid-row grid-gap">
<div class="grid-col-auto">
<a href="mailto:accessibility-qa.civicactions.com">
accessibility-qa.civicactions.com
</a>
</div>
</div>
</address>
</div>
</div>
</div>
</div>
</footer>
<script src="/assets/uswds/js/uswds.min.js" async></script>
</body>
</html>