Skip to content

Commit 229b80d

Browse files
committed
Update text styles and navigation
1 parent dae5bad commit 229b80d

File tree

3 files changed

+55
-38
lines changed

3 files changed

+55
-38
lines changed

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

+30-30
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ 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-
<h4 class="b-header has-text-grey is-marginless">Step 0</h4>
16-
### Evaluate Process
15+
#### Step 0
16+
## Evaluate Process
1717

18-
**Figure out if you need to follow this process.**
18+
##### Figure out if you need to follow this process.
1919

2020
Please note that this process is only for adding significant features that require product input or infrastructural work from CC staff. If you are just fixing a bug or making an improvement to existing features, follow [our much simpler guidelines for contributing code](/contributing-code/). If you're not sure what category your proposed change falls under, ask us on GitHub or via [our chat/mailing list](/community/).
2121

@@ -34,19 +34,19 @@ Examples that should follow this process:
3434
- Adding a new filter to the search results page
3535
- **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.
3636

37-
<h4 class="b-header has-text-grey is-marginless">Step 1</h4>
38-
### GitHub Issue
37+
#### Step 1
38+
## GitHub Issue
3939

40-
**Describe the feature on GitHub.**
40+
##### Describe the feature on GitHub.
4141

4242
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.
4343

4444
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.
4545

46-
<h4 class="b-header has-text-grey is-marginless">Step 2</h4>
47-
### CC Response
46+
#### Step 2
47+
## CC Response
4848

49-
**Wait for a CC staff member to respond.**
49+
##### Wait for a CC staff member to respond.
5050

5151
Someone on the CC Search staff will aim to review your comments within five business days and get back to you with one of these responses:
5252

@@ -58,10 +58,10 @@ If at any time it has been more than five business days and you haven't received
5858

5959
Once your feature has been preliminarily approved, proceed to Step 3.
6060

61-
<h4 class="b-header has-text-grey is-marginless">Step 3</h4>
62-
### Planning
61+
#### Step 3
62+
## Planning
6363

64-
**Plan your work.**
64+
##### Plan your work.
6565

6666
Create an implementation plan with the list of changes you'll need to make to implement your feature.
6767

@@ -71,50 +71,50 @@ Once your implementation plan is ready, update the GitHub issue and wait for a s
7171

7272
Once your plan has been approved, proceed to the next applicable step.
7373

74-
<h4 class="b-header has-text-grey is-marginless">Step 4</h4>
75-
### Design
74+
#### Step 4
75+
## Design
7676

77-
**Get Design and UX approved (if applicable).**
77+
##### Get Design and UX approved (if applicable).
7878

7979
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.
8080

8181
Once your design has been approved, proceed to Step 5.
8282

83-
<h4 class="b-header has-text-grey is-marginless">Step 5</h4>
84-
### Dependencies
83+
#### Step 5
84+
## Dependencies
8585

86-
**Wait for CC staff to resolve dependencies (if applicable).**
86+
##### Wait for CC staff to resolve dependencies (if applicable).
8787

8888
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.
8989

90-
<h4 class="b-header has-text-grey is-marginless">Step 6</h4>
91-
### Code
90+
#### Step 6
91+
## Code
9292

93-
**Write your code.**
93+
##### Write your code.
9494

9595
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!
9696

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

99-
<h4 class="b-header has-text-grey is-marginless">Step 7</h4>
100-
### Code Review
99+
#### Step 7
100+
## Code Review
101101

102-
**Get feedback via code review.**
102+
##### Get feedback via code review.
103103

104104
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.
105105

106106
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.
107107

108-
<h4 class="b-header has-text-grey is-marginless">Step 8</h4>
109-
### Staging
108+
#### Step 8
109+
## Staging
110110

111-
**Get feedback via live testing.**
111+
##### Get feedback via live testing.
112112

113113
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.
114114

115-
<h4 class="b-header has-text-grey is-marginless">Step 9</h4>
116-
### Production
115+
#### Step 9
116+
## Production
117117

118-
**The feature is live!**
118+
##### The feature is live!
119119

120120
Once any feedback from Step 8 is resolved, we will merge your code into the stable branch and deploy it to production. Congrats, your feature is live!

themes/vocabulary_theme/templates/cc-search-guide.html

+10-6
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,17 @@ <h1>{{ this.title }}</h1>
1313
<div class="table-of-progress">
1414
<h4 class="step-header">Steps</h4>
1515
<ul>
16+
{% set step = namespace (number = 0) %}
1617
{% 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>
18+
{% if (loop.index + 1)%3 == 0 %}
19+
<li class="step">
20+
<a class="link" href="#{{ this.body.toc[loop.index - 2].anchor }}">
21+
<span class="number">{{ step.number }}</span>
22+
<span class="name">{{ item.title }}</span>
23+
</a>
24+
</li>
25+
{% set step.number = step.number + 1 %}
26+
{% endif%}
2327
{% endfor %}
2428
</ul>
2529
</div>

webpack/sass/main.scss

+15-2
Original file line numberDiff line numberDiff line change
@@ -532,8 +532,21 @@ code {
532532
@extend .padding-bottom-xxl;
533533

534534
.content {
535-
h3 {
536-
margin-top: 0rem;
535+
h2 {
536+
@extend .is-marginless;
537+
@extend .padding-bottom-small;
538+
}
539+
h4 {
540+
@extend .b-header;
541+
@extend .is-marginless;
542+
@extend .padding-bottom-small;
543+
544+
color: $color-gray;
545+
}
546+
h5 {
547+
@extend .is-marginless;
548+
@extend .b-header;
549+
@extend .padding-bottom-big;
537550
}
538551
}
539552
}

0 commit comments

Comments
 (0)