Skip to content

Commit e909c9c

Browse files
jmassardojmassardo
committed
Update layout for design documents and improve terminology link in index
1 parent 0a3145f commit e909c9c

17 files changed

+118
-100
lines changed

‎_includes/page_header.html

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<header class="hero-banner">
2+
<div class="wrapper">
3+
<div class="hero-banner__content" data-animate-in="up">
4+
<h1 class="h0 mt-0 text-black">{{ page.title }}</h1>
5+
<p class="p-lg">{{ page.subtitle }}</p>
6+
</div>
7+
</div>
8+
</header>
9+
10+
<div class="wrapper ">
11+
{% unless page.name == "index.md" %}
12+
<nav aria-label="breadcrumb">
13+
<ol class="breadcrumb">
14+
15+
{% for category in site.menu %}
16+
{% if category.id == page.category %}
17+
<li class="breadcrumb-item"><a href="/{{ page.category }}">{{ category.name }}</a></li>
18+
{% if category.subcategory %}
19+
{% for subcategory in category.subcategory %}
20+
{% if subcategory.id == page.subcategory %}
21+
<li class="breadcrumb-item"><a href="/{{ page.category }}/{{ page.subcategory }}">{{ subcategory.name }}</a></li>
22+
{% endif %}
23+
{% endfor %}
24+
{% endif %}
25+
{% endif %}
26+
{% endfor %}
27+
28+
29+
<li class="breadcrumb-item active" aria-current="page">{{ page.title }}</li>
30+
</ol>
31+
</nav>
32+
<br/>
33+
{% endunless %}
34+
<div class="skill-level">
35+
<p>
36+
<b>Intended audience:</b>
37+
<span>{{ page.audience }}</span>
38+
</p>
39+
</div>
40+
</div>

‎_layouts/article.html

+32-49
Original file line numberDiff line numberDiff line change
@@ -9,60 +9,43 @@
99
{% include menu.html %}
1010
<main id="content" class="main page-content" aria-label="Content">
1111
<article>
12-
<header class="hero-banner hero-banner--auto-height">
13-
<div class="wrapper">
14-
<div class="hero-banner__content" data-animate-in="up">
15-
<h1 class="h0 mt-0 mb-3 text-black">{{ page.title }}</h1>
16-
<p class="p-lg">{{ page.subtitle }}</p>
17-
</div>
18-
</div>
19-
</header>
12+
{% include page_header.html %}
13+
<div class="wrapper py-4 mb-4 rte long-form">
14+
{{ content }}
2015

21-
<div class="wrapper mt-6 pt-6 pt-md-4 pb-4">
22-
<nav aria-label="breadcrumb">
23-
<ol class="breadcrumb">
24-
{% assign category_name = "" %}
25-
{% assign subcategory_name = "" %}
16+
<p> <b>Contributer(s): </b>{{ page.author }}</p>
2617

27-
{% for category in site.menu %}
28-
{% if category.name == page.category %}
29-
{% assign category_name = category.name %}
30-
{% if category.subcategory %}
31-
{% for subcategory in category.subcategory %}
32-
{% if subcategory.name == page.subcategory %}
33-
{% assign subcategory_name = subcategory.name %}
34-
{% endif %}
35-
{% endfor %}
18+
<div class="navigation-buttons" style="display: flex; justify-content: space-between;">
19+
{% if page.previous == "index" %}
20+
<a class="btn btn-secondary" href="index.html">Go back to the list of articles</a>
21+
{% else %}
22+
{% for site_page in site.html_pages %}
23+
{% if site_page.name != "index.md" %}
24+
{% assign full_previous_page_path = "/" | append: page.category | append: '/' | append: page.subcategory | append: '/' | append: page.previous | append: '.html' %}
25+
{% if full_previous_page_path == site_page.url %}
26+
<a class="btn btn-secondary" href="{{ page.previous }}.html">Go back to: {{ site_page.title }}</a>
27+
{% endif %}
3628
{% endif %}
37-
{% endif %}
38-
{% endfor %}
39-
40-
<li class="breadcrumb-item"><a href="/{{ page.category }}">{{ page.category }}</a></li>
41-
<li class="breadcrumb-item"><a href="/{{ page.category }}/{{ page.subcategory }}">{{ page.subcategory }}</a></li>
42-
<li class="breadcrumb-item active" aria-current="page">{{ page.title }}</li>
43-
</ol>
44-
</nav>
45-
<div class="skill-level">
46-
<p>
47-
<b>Intended audience:</b>
48-
<span>{{ page.audience }}</span>
49-
</p>
50-
</div>
51-
</div>
52-
<div class="wrapper-thin-alt py-6 mb-6 rte long-form">
53-
{{ content }}
29+
{% endfor %}
30+
{% endif %}
31+
32+
{% if page.next == "index" %}
33+
<a class="btn btn-secondary" href="index.html">Go back to the list of articles</a>
34+
{% else %}
35+
{% for site_page in site.html_pages %}
36+
{% if site_page.name != "index.md" %}
37+
{% assign full_next_page_path = "/" | append: page.category | append: '/' | append: page.subcategory | append: '/' | append: page.next | append: '.html' %}
38+
{% if full_next_page_path == site_page.url %}
39+
<a class="btn btn-secondary" href="{{ page.next }}.html">Proceed to: {{ site_page.title }}</a>
40+
{% endif %}
41+
{% endif %}
42+
{% endfor %}
43+
{% endif %}
5444

55-
<p> <b>Contributer(s): </b>{{ page.author }}</p>
56-
<div class="navigation-buttons">
57-
{% if page.previous %}
58-
<a class="btn btn-secondary" href="{{ page.previous }}.html">Go back to: article name</a>
59-
{% endif %}
60-
{% if page.next %}
61-
{# if we hit the end of a section, proceed to the index of the next section #}
62-
<a class="btn btn-secondary" href="{{ page.next }}html">Proceed to: article name</a>
63-
{% endif %}
64-
</div>
45+
6546

47+
</div>
48+
6649
</div>
6750
{% include footer.html %}
6851

‎_layouts/default.html

+2-18
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,8 @@
99
{% include menu.html %}
1010
<main id="content" class="main page-content" aria-label="Content">
1111
<article>
12-
<header class="hero-banner hero-banner--auto-height">
13-
<div class="wrapper">
14-
<div class="hero-banner__content" data-animate-in="up">
15-
<h1 class="h0 mt-0 mb-3 text-black">{{ page.title }}</h1>
16-
<p class="p-lg">{{ page.subtitle }}</p>
17-
</div>
18-
</div>
19-
</header>
20-
21-
<div class="wrapper mt-6 pt-6 pt-md-4 pb-4">
22-
<div class="skill-level">
23-
<p>
24-
<b>Intended audience:</b>
25-
<span>{{ page.audience }}</span>
26-
</p>
27-
</div>
28-
</div>
29-
<div class="wrapper-thin-alt py-6 mb-6 rte long-form">
12+
{% include page_header.html %}
13+
<div class="wrapper py-4 mb-4 rte long-form">
3014
{{ content }}
3115

3216
<p> <b>Contributer(s): </b>{{ page.author }}</p>

‎_layouts/page.html

+2-18
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,8 @@
99
{% include menu.html %}
1010
<main id="content" class="main page-content" aria-label="Content">
1111
<article>
12-
<header class="hero-banner hero-banner--auto-height">
13-
<div class="wrapper">
14-
<div class="hero-banner__content" data-animate-in="up">
15-
<h1 class="h0 mt-0 mb-3 text-black">{{ page.title }}</h1>
16-
<p class="p-lg">{{ page.subtitle }}</p>
17-
</div>
18-
</div>
19-
</header>
20-
21-
<div class="wrapper mt-6 pt-6 pt-md-4 pb-4">
22-
<div class="skill-level">
23-
<p>
24-
<b>Intended audience:</b>
25-
<span>{{ page.audience }}</span>
26-
</p>
27-
</div>
28-
</div>
29-
<div class="wrapper-thin-alt py-6 mb-6 rte long-form">
12+
{% include page_header.html %}
13+
<div class="wrapper py-4 mb-4 rte long-form">
3014
{{ content }}
3115

3216
<p> <b>Contributer(s): </b>{{ page.author }}</p>

‎index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The primary audience for the Playbook is DataKind volunteers to guide them in th
4343

4444
**I encountered an unfamiliar term, what does it mean?**
4545

46-
If you encounter an unfamiliar term, refer to our terminology page for more information.
46+
If you encounter an unfamiliar term, refer to our [terminology page]({{ site.baseurl }}{% link volunteers/getting-started/key_terminology.md %}) for more information.
4747

4848
**How do I provide feedback or ask questions?**
4949

‎project-stages/design/consulting_additional_key_stakeholders.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Consulting Additional Key Stakeholders
44
date: 02/29/2024
55
author: Afua Bruce, Mitali Ayyangar, Benjamin Kinsella, Cassy L Cox, Nathan Banion, Rachel Wells, Caitlin Augustin, Emily Yelverton, Daniel Nissani, Phil Azar, Mallory Sheff
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: evaluating_data_inclusion
10+
next: project_risk_and_ethical_assessment
911
---
1012

1113
DataKind’s best work is done when we are able to include both subject matter experts and local stakeholders in the Design Stage \- each group can provide invaluable context and insights to inform project design.

‎project-stages/design/data_audit.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
layout: default
2+
layout: article
33
title: Data Audit
44
subtitle:
55
date: 02/29/2024
66
author: Benjamin Kinsella, Nathan Banion, Seward Lee, Rachel Wells
77
audience: DataKind Volunteers
88
category: project-stages
99
subcategory: design
10+
previous: data_storage_security_and_management_processes
11+
next: evaluating_data_inclusion
1012
---
1113

1214
Before you begin designing the project, you’ll need to perform a Data Audit to ensure that a data science project is feasible and responsible. The main goal here is to confirm whether the available data can support a project that meets the objectives, in addition to identifying salient issues related to data provenance, quality, and ethics. It is not required that you exhaustively outline all available tables and variables (though this process may be helpful for you!). Rather, you're demonstrating a proof of concept, answering: “Given our objective, do these data have what we need?.” Use the [Data Audit Report Template](https://docs.google.com/document/d/10QyBpO_0uNOtzQ4Kfqkw3cv-1wv-BjYP_VJj_zyYzwc/edit?usp=sharing) to ensure that you leave no stone unturned during your audit.

‎project-stages/design/data_science_software_and_tools.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Data Science Software and Tools
44
date: 02/29/2024
55
author: Neal Fultz, Arina Igumenshcheva, Nathan Banion, Seward Lee, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: define_success_metrics_and_create_a_measurement_plan
10+
next: the_project_brief_and_defining_your_deliverables
911
---
1012

1113
As you design your project, you’ll reach a point where you’ll need to decide what data science tools to use. As you assess whether a tool is a good fit for this project, consider:

‎project-stages/design/define_success_metrics_and_create_a_measurement_plan.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Define Success Metrics and Create a Measurement Plan
44
date: 02/29/2024
55
author: Benjamin Kinsella, Jack Craft, Matthew Harris, Arina Igumenshcheva, Daniel Nissani, Daniel Nissani, William Ratcliff, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: determine_technical_methodology
10+
next: data_science_software_and_tools
911
---
1012

1113
##### Inputs from Discovery stage:

‎project-stages/design/design_checkpoint.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Design Checkpoint
44
date: 02/29/2024
55
author: Benjamin Kinsella, Bhargav Kowshik, Matthew Harris, Arina Igumenshcheva, Michael Wegan, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: when_to_pause_design
10+
next: index
911
---
1012

1113
The Design Checkpoint is the point at which the team officially decides whether or not to take on a project. This decision is made by the advisory team (i.e., Chapter Leader(s), DataKind staff support person, etc.).

‎project-stages/design/determine_technical_methodology.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Determine Technical Methodology
44
date: 02/29/2024
55
author: Benjamin Kinsella, Srivalya Elluru, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: data_storage_security_and_management_processes
10+
next: evaluating_data_inclusion
911
---
1012

1113
At DataKind, our [working definition of data science](/volunteers/getting-started/key_terminology) is using computers to interpret data, model relationships in data, and create data\-driven algorithms. This often involves the use of advanced analytical and computational techniques to extract new information from novel data sources, usually for the sake of supporting organizational decision making or increasing efficiency. To sum it up then, data science is the necessary processing of otherwise overwhelming and messy information to help our human brains make better decisions.

‎project-stages/design/evaluating_data_inclusion.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Evaluating Data Inclusion
44
date: 02/29/2024
55
author: Caitlin Augustin, Benjamin Kinsella, Emily Yelverton, Jeremy Osborn, Manojit Nandi, Daniel Nissani, Phil Azar, William Ratcliff, Mallory Sheff, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: data_audit
10+
next: consulting_additional_key_stakeholders
911
---
1012

1113
Data inclusion ensures the data are representative and are not missing any people, variables, communities, or indicators. Evaluating possible data inclusion risks means understanding the assumptions that are made when collecting, curating, or tagging data by evaluating the abstract notions of data, what’s included, and decisions that were made in collection.

‎project-stages/design/project_risk_and_ethical_assessment.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: Project Risk and Ethical Assessment
44
date: 02/29/2024
55
author: Benjamin Kinsella, Manojit Nandi, Daniel Nissani, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: consulting_additional_key_stakeholders
10+
next: determine_technical_methodology
911
---
1012

1113
Assessing and mitigating risks is imperative in any data science project. In addition to the strategies outlined in the [evaluating data inclusion article](evaluating_data_inclusion), use the following tips and considerations as you assess the ethics and risks of your potential project. Keep in mind that this guide is not meant to be comprehensive. Let the examples and suggestions below inspire you to think carefully about risks and determine your own evaluation approach that will ensure you are prepared to produce products that will be used for good.

‎project-stages/design/the_project_brief_and_defining_your_deliverables.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: The Project Brief and Defining Your Deliverables
44
date: 02/29/2024
55
author: Caitlin Augustin, Mitali Ayyangar, Benjamin Kinsella, Emily Yelverton, Rachel Wells, Caroline Charrow, Nathan Banion, Seward Lee
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: data_science_software_and_tools
10+
next: the_service_agreement
911
---
1012

1113
As you plan out your project, you’ll need to explicitly and clearly define the project deliverables. This is a very important step for multiple reasons:

‎project-stages/design/the_service_agreement.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: The Service Agreement
44
date: 02/29/2024
55
author: Gwen Hopkins, Shanna Lee, Russatta Buford, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: the_project_brief_and_defining_your_deliverables
10+
next: when_to_pause_design
911
---
1012

1113
Congratulations \-\- if you’ve made it to the Services Agreement, that means you’re ready to launch a project! How exciting! But before you jump right into the project work, note that roughly 10 business days are needed for DataKind’s Operations Team to complete a contract review, and this MUST be in place before any work is done.

‎project-stages/design/when_to_pause_design.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
layout: default
2+
layout: article
33
title: When to Pause, Discontinue, or Decline a Project in the Design Stage
44
date: 02/29/2024
55
author: Caitlin Augustin, Mitali Ayyangar, Benjamin Kinsella, Emily Yelverton, Arina Igumenshcheva, Mallory Sheff, Rachel Wells
66
audience: DataKind Volunteers
77
category: project-stages
88
subcategory: design
9+
previous: the_service_agreement
10+
next: design_checkpoint
911
---
1012

1113
Just like in the [Discover Stage](/project-stages/discovery/when_to_pause_discovery), you may be faced with the decision to pause, discontinue, or even decline a potential project during the Design Stage of the scoping process. While you will need to make the decision to either continue with the partner organization or not, the job of Scopers is to think about what the team is missing and communicate that to the organization. This article will help you think about these decisions and communicate them with the partner organization.

‎public/css/index.css

+8-3
Original file line numberDiff line numberDiff line change
@@ -21468,7 +21468,7 @@ body.search-is-open .search-mask {
2146821468
position: relative;
2146921469
z-index: 2;
2147021470
background: #FFFFFF;
21471-
padding: 40px 0
21471+
padding: 0
2147221472
}
2147321473

2147421474
@media (min-width: 1012px) {
@@ -21512,7 +21512,7 @@ body.search-is-open .search-mask {
2151221512
padding: 24px 0;
2151321513
flex-grow: 1;
2151421514
order: 1;
21515-
max-width: 60%
21515+
max-width: 80%
2151621516
}
2151721517
}
2151821518

@@ -25472,4 +25472,9 @@ body.localhost:after {
2547225472

2547325473
.search-results-ul span {
2547425474
font-style: italic;
25475-
}
25475+
}
25476+
25477+
.navigation-buttons {
25478+
display: flex;
25479+
justify-content: space-between;
25480+
}

0 commit comments

Comments
 (0)