Skip to content

Commit e55d69f

Browse files
committed
Update CC-Search guide page
1 parent 3a695a9 commit e55d69f

File tree

3 files changed

+71
-11
lines changed

3 files changed

+71
-11
lines changed

content/contributing-code/cc-search/contents.lr

+21-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
_model: page
22
---
3-
_template: page-with-toc.html
3+
_template: cc-search-guide.html
44
---
55
title: Building a New Feature in CC Search
66
---
@@ -12,7 +12,8 @@ We also want to enable you - our community members - to build features that woul
1212

1313
If you do want to build a new feature, and we would love it if you did, all we ask is that you follow the process outlined in this document to ensure a smooth experience for everyone involved.
1414

15-
### Step 0: Evaluate Process
15+
<h4 class="b-header has-text-grey">Step 0</h4>
16+
### Evaluate Process
1617

1718
**Figure out if you need to follow this process.**
1819

@@ -33,15 +34,17 @@ Examples that should follow this process:
3334
- Adding a new filter to the search results page
3435
- **Reasoning**: It is user facing and requires some product input and may require infrastructural work to collect the data that the search results will filter on.
3536

36-
### Step 1: GitHub Issue
37+
<h4 class="b-header has-text-grey">Step 1</h4>
38+
### GitHub Issue
3739

3840
**Describe the feature on GitHub.**
3941

4042
Look through [our issues](https://github.com/creativecommons/cccatalog-frontend/issues) to see if there is already a GitHub issue describing the feature you want to build. If none exists, create one on the [cccatalog-frontend](https://github.com/creativecommons/cccatalog-frontend/issues) repository (which holds the code for CC Search) using the "Feature request" template.
4143

4244
On this GitHub issue, add a comment describing the feature you want to build and why you think it would be a good addition to CC Search. Add as much detail as you can.
4345

44-
### Step 2: CC Response
46+
<h4 class="b-header has-text-grey">Step 2</h4>
47+
### CC Response
4548

4649
**Wait for a CC staff member to respond.**
4750

@@ -55,7 +58,8 @@ If at any time it has been more than five business days and you haven't received
5558

5659
Once your feature has been preliminarily approved, proceed to Step 3.
5760

58-
### Step 3: Planning
61+
<h4 class="b-header has-text-grey">Step 3</h4>
62+
### Planning
5963

6064
**Plan your work.**
6165

@@ -67,43 +71,49 @@ Once your implementation plan is ready, update the GitHub issue and wait for a s
6771

6872
Once your plan has been approved, proceed to the next applicable step.
6973

70-
### Step 4: Design
74+
<h4 class="b-header has-text-grey">Step 4</h4>
75+
### Design
7176

7277
**Get Design and UX approved (if applicable).**
7378

7479
If your feature involves user-facing changes, please run these by us, either through wireframes or high fidelity mockups. We will either approve your design or provide feedback and ask you to make some changes.
7580

7681
Once your design has been approved, proceed to Step 5.
7782

78-
### Step 5: Dependencies
83+
<h4 class="b-header has-text-grey">Step 5</h4>
84+
### Dependencies
7985

8086
**Wait for CC staff to resolve dependencies (if applicable).**
8187

8288
If your feature depends on work that only CC staff can do, please wait for us to do that work. If you can start working on other parts of the feature in parallel, you may go ahead.
8389

84-
### Step 6: Code
90+
<h4 class="b-header has-text-grey">Step 6</h4>
91+
### Code
8592

8693
**Write your code.**
8794

8895
At this point, CC staff and you should be on the same page about how the feature will be implemented and what it will look like. Here's where you get to actually implement it!
8996

9097
Commit early and often, follow [our pull request and code guidelines](/contributing-code/pr-guidelines/), and write tests!
9198

92-
### Step 7: Code Review
99+
<h4 class="b-header has-text-grey">Step 7</h4>
100+
### Code Review
93101

94102
**Get feedback via code review.**
95103

96104
Once your pull request is ready, someone on CC staff will review your code and provide feedback. Once all feedback has been resolved, your code will be merged into the main branch of the repository.
97105

98106
You may have to do Steps 4-7 for multiple codebases in some cases, e.g. if your work includes both the CC Catalog API and CC Search, the API work will have to be done before the CC Search work that depends on it.
99107

100-
### Step 8: Staging
108+
<h4 class="b-header has-text-grey">Step 8</h4>
109+
### Staging
101110

102111
**Get feedback via live testing.**
103112

104113
Once your code is merged, it will be deployed to the staging server and tested manually (in addition to the comprehensive automated tests that you've already written). We may need to run some changes by our product counsel. This may produce an additional round of feedback for you to address.
105114

106-
### Step 9: Production
115+
<h4 class="b-header has-text-grey">Step 9</h4>
116+
### Production
107117

108118
**The feature is live!**
109119

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{% extends "layout.html" %}
2+
3+
{% block body %}
4+
<div class="cc-search-guide">
5+
<header class="title">
6+
<div class="container is-paddingless">
7+
<h1>{{ this.title }}</h1>
8+
</div>
9+
</header>
10+
<div class="container body">
11+
<div class="columns">
12+
<div class="column is-one-quarter">
13+
<div class="table-of-progress">
14+
<h4 class="step-header">Steps</h4>
15+
<ul>
16+
{% for item in this.body.toc %}
17+
<li class="step">
18+
<a class="link" href="#{{ item.anchor }}">
19+
<span class="number">{{ loop.index - 1 }}</span>
20+
<span class="name">{{ item.title }}</span>
21+
</a>
22+
</li>
23+
{% endfor %}
24+
</ul>
25+
</div>
26+
</div>
27+
<div class="column markdown content">
28+
{{ this.body }}
29+
</div>
30+
</div>
31+
</div>
32+
</div>
33+
{% endblock %}

webpack/sass/main.scss

+17
Original file line numberDiff line numberDiff line change
@@ -515,3 +515,20 @@ code {
515515
}
516516
}
517517
}
518+
519+
.cc-search-guide {
520+
.title {
521+
background-color: $color-lighter-gray;
522+
523+
.container {
524+
@extend .padding-horizontal-big;
525+
@extend .padding-bottom-xl;
526+
}
527+
}
528+
529+
.body {
530+
@extend .padding-horizontal-big;
531+
@extend .padding-top-xl;
532+
@extend .padding-bottom-xxl;
533+
}
534+
}

0 commit comments

Comments
 (0)