Skip to content

Commit d096112

Browse files
Dhruvi16Dhruvi16
authored
Merge pull request creativecommons#348 from creativecommons/update_cc_search
Update ccsearch roadmap page.
2 parents a3fe548 + ffef487 commit d096112

File tree

2 files changed

+115
-71
lines changed

2 files changed

+115
-71
lines changed

‎themes/vocabulary_theme/templates/search_roadmap.html

+78-71
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,89 @@
11
{% extends "layout.html" %}
2-
{% block title %}{{ this.title }}{% endblock %}
2+
33
{% block body %}
4-
<p>The largest open source product in CC’s portfolio is CC Search: a search engine for CC licensed and public domain creative works. The product involves the following components:</p>
5-
<ul>
4+
<div class="cc-search-roadmap">
5+
<div class="title">
6+
<div class="container">
7+
<h1>{{ this.title }}</h1>
8+
<p class="description column is-9">The largest open source product in CC’s portfolio is CC Search: a search engine for CC licensed and public domain creative works.</p>
9+
</div>
10+
</div>
11+
<div class="body container">
12+
<p>The product involves the following components:</p>
13+
<ul>
614
<li><b>CC Catalog</b>, where CC licensed and public domain works are ingested. [<a href="https://github.com/creativecommons/cccatalog">GitHub Repo</a>]</li>
715
<li><b>CC Catalog API</b>, our open API, used by CC Search to make the Catalog discoverable. [<a href="https://github.com/creativecommons/cccatalog-api">GitHub Repo</a>][<a href="https://api.creativecommons.engineering/v1/">Developer Documentation</a>]</li>
816
<li><b>CC Search</b>, our user facing search engine. [<a href="https://github.com/creativecommons/cccatalog-frontend">GitHub Repo</a>][<a href="https://search.creativecommons.org">Website</a>]</li>
9-
</ul>
10-
<p>CC Catalog ingests and processes CC licensed and public domain works, then makes that data available to CC Catalog API. CC Catalog API is publicly accessible, and is used to serve the data from the catalog to CC Search.</p>
17+
</ul>
18+
<p>CC Catalog ingests and processes CC licensed and public domain works, then makes that data available to CC Catalog API. CC Catalog API is publicly accessible, and is used to serve the data from the catalog to CC Search.</p>
19+
20+
<h3 class="padding-vertical-normal">What Are We Up To?</h3>
21+
<p>The highlights on our roadmap for the current and upcoming quarters are as follows:</p>
22+
{% for quarter in bag('search_roadmap.quarters') %}
23+
<h4 class="padding-vertical-normal">{{ quarter.name }}</h4>
24+
<div class="table-container">
25+
<table class="table is-bordered is-striped">
26+
<thead>
27+
<tr>
28+
<th scope="col">Task Name</th>
29+
<th scope="col">Task Description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
{% for task in quarter.tasks %}
34+
<tr>
35+
<th scope="row">{{ task.name }}</th>
36+
<td scope="row">{{ task.description }}</td>
37+
</tr>
38+
{% endfor %}
39+
</tbody>
40+
</table>
41+
</div>
42+
{% endfor %}
43+
<p>Review our Pipeline of Future Ideas <a href="https://docs.google.com/document/d/1qAZu1_ZltfdVylH6WkWcp5_mBAPa5ilflHWUc7zbIgk/edit#">here</a> if you want to see what else has been suggested for CC Search.</p>
44+
<h3 class="padding-vertical-normal">How Can I Help?</h3>
45+
<h4 class="padding-vertical-normal">Contribute Code</h4>
46+
<p>To contribute code, take the following steps:</p>
47+
<ul>
48+
<li>
49+
Review the following:
50+
<ul>
51+
<li>Our Contribution Guidelines: <a href="/contributing-code/">https://opensource.creativecommons.org/contributing-code/</a></li>
52+
<li>CC Search's Contribution Guidelines: <a href="/contributing-code/cc-search/">https://opensource.creativecommons.org/contributing-code/cc-search/</a></li>
53+
</ul>
54+
</li>
55+
<li>Determine which project works best for you</li>
56+
<li>Read through <a href="/contributing-code/#finding-an-issue">how to find open issues</a>.</li>
57+
<li>Start contributing!</li>
58+
</ul>
1159

12-
<h3>What Are We Up To?</h3>
13-
<p>The highlights on our roadmap for the current and upcoming quarters are as follows:</p>
14-
15-
<div>
16-
{% for quarter in bag('search_roadmap.quarters') %}
17-
<h4>{{ quarter.name }}</h4>
18-
<table class="table table-striped">
19-
<thead class="thead-dark">
20-
<tr>
21-
<th scope="col">Task Name</th>
22-
<th scope="col">Task Description</th>
23-
</tr>
24-
</thead>
25-
<tbody>
26-
{% for task in quarter.tasks %}
27-
<tr>
28-
<th scope="row">{{ task.name }}</th>
29-
<td scope="row">{{ task.description }}</td>
30-
</tr>
31-
{% endfor %}
32-
</tbody>
33-
</table>
34-
{% endfor %}
35-
</div>
36-
37-
<p>Review our Pipeline of Future Ideas <a href="https://docs.google.com/document/d/1qAZu1_ZltfdVylH6WkWcp5_mBAPa5ilflHWUc7zbIgk/edit#">here</a> if you want to see what else has been suggested for CC Search.</p>
3860

39-
<h3>How Can I Help?</h3>
40-
<h4>Contribute Code</h4>
41-
<p>To contribute code, take the following steps:</p>
42-
<ol>
43-
<li>
44-
Review the following:
45-
<ul>
46-
<li>Our Contribution Guidelines: <a href="/contributing-code/">https://opensource.creativecommons.org/contributing-code/</a></li>
47-
<li>CC Search's Contribution Guidelines: <a href="/contributing-code/cc-search/">https://opensource.creativecommons.org/contributing-code/cc-search/</a></li>
48-
</ul>
49-
</li>
50-
<li>Determine which project works best for you</li>
51-
<li>Read through <a href="/contributing-code/#finding-an-issue">how to find open issues</a>.</li>
52-
<li>Start contributing!</li>
53-
</ol>
61+
<b>We keep track of our work in three projects in GitHub:</b>
62+
<dl>
63+
<dt><a href="https://github.com/orgs/creativecommons/projects/7">CC Search Active Sprint</a></dt>
64+
<dd>&bull; The best place to start! If an issue isn’t in progress yet, and is marked for community contribution, you’ll know it’s our highest priority.</dd>
65+
<dt><a href="https://github.com/orgs/creativecommons/projects/10">CC Search Backlog</a></dt>
66+
<dd>&bull; The column called “Next Sprint” contains what our second highest priority items are.</dd>
67+
<dd>&bull; The current quarter (Q1, Q2, Q3, Q4) will tell you what we plan to work on, up to three months out.</dd>
68+
<dd>&bull; Check out the “Any Time/Community” for some fun tickets that aren’t a high priority for CC staff, but would be great if they got built.</dd>
69+
<dt><a href="https://github.com/orgs/creativecommons/projects/12">CC Catalog Pipeline</a></dt>
70+
<dd>&bull; There are two columns with “Ready for Work” tickets. If they’re not blocked or marked as CC Staff only, we welcome your contribution.</dd>
71+
</dl>
5472

73+
<h4 class="padding-vertical-normal">Contribute Design</h4>
74+
<p>There are two ways you can show your interest in contributing to the design of CC Search:</p>
75+
<ul>
76+
<li>Follow <a href="https://opensource.creativecommons.org/contributing-code/cc-search/">the steps for suggesting a new feature for CC Search</a></li>
77+
<li>Join the #cc-search channel in the <a href="https://slack-signup.creativecommons.org/">Creative Commons Slack</a> and start a conversation about your design ideas.</li>
78+
</ul>
5579

56-
<b>We keep track of our work in three projects in GitHub:</b>
57-
<dl>
58-
<dt><a href="https://github.com/orgs/creativecommons/projects/7">CC Search Active Sprint</a></dt>
59-
<dd>&bull; The best place to start! If an issue isn’t in progress yet, and is marked for community contribution, you’ll know it’s our highest priority.</dd>
60-
<dt><a href="https://github.com/orgs/creativecommons/projects/10">CC Search Backlog</a></dt>
61-
<dd>&bull; The column called “Next Sprint” contains what our second highest priority items are.</dd>
62-
<dd>&bull; The current quarter (Q1, Q2, Q3, Q4) will tell you what we plan to work on, up to three months out.</dd>
63-
<dd>&bull; Check out the “Any Time/Community” for some fun tickets that aren’t a high priority for CC staff, but would be great if they got built.</dd>
64-
<dt><a href="https://github.com/orgs/creativecommons/projects/12">CC Catalog Pipeline</a></dt>
65-
<dd>&bull; There are two columns with “Ready for Work” tickets. If they’re not blocked or marked as CC Staff only, we welcome your contribution.</dd>
66-
</dl>
80+
<p>Before you start work on any design project, get familiar with <a href="https://www.figma.com/file/l4Mt3dn3Ndtrvrb4aLcwXI/Design-Library?node-id=1433%3A0">our design library in Figma</a>. All CC Search designs use this design library.</p>
6781

68-
<h4>Contribute Design</h4>
69-
<p>There are two ways you can show your interest in contributing to the design of CC Search:</p>
70-
<ol>
71-
<li>Follow <a href="https://opensource.creativecommons.org/contributing-code/cc-search/">the steps for suggesting a new feature for CC Search</a></li>
72-
<li>Join the #cc-search channel in the <a href="https://slack-signup.creativecommons.org/">Creative Commons Slack</a> and start a conversation about your design ideas.</li>
73-
</ol>
74-
75-
<p>Before you start work on any design project, get familiar with <a href="https://www.figma.com/file/l4Mt3dn3Ndtrvrb4aLcwXI/Design-Library?node-id=1433%3A0">our design library in Figma</a>. All CC Search designs use this design library.</p>
76-
77-
<h4>Participate in Usability Tests and User Interviews</h4>
78-
<p>When we’re rolling out a specific feature, we do usability tests to test the proposed experience.</p>
79-
<p>At any point in time, we’re engaging with our users through user interviews, where we learn more about attitudes towards the product as it stands, and dig into expansion areas we’re considering.</p>
80-
<p>If you’re interested, we invite you to sign up for a time <a href="https://calendly.com/cc-product-design/usability-test-30">via this Calendly link</a>.</p>
81-
<p>Visit our <a href="/contributing-code/usability/">Usability page</a> for more details on how to participate.</p>
82+
<h4 class="padding-vertical-normal">Participate in Usability Tests and User Interviews</h4>
83+
<p>When we’re rolling out a specific feature, we do usability tests to test the proposed experience.</p>
84+
<p>At any point in time, we’re engaging with our users through user interviews, where we learn more about attitudes towards the product as it stands, and dig into expansion areas we’re considering.</p>
85+
<p>If you’re interested, we invite you to sign up for a time <a href="https://calendly.com/cc-product-design/usability-test-30">via this Calendly link</a>.</p>
86+
<p>Visit our <a href="/contributing-code/usability/">Usability page</a> for more details on how to participate.</p>
87+
</div>
88+
</div>
8289
{% endblock %}

‎webpack/sass/main.scss

+37
Original file line numberDiff line numberDiff line change
@@ -590,3 +590,40 @@ code {
590590
}
591591
}
592592
}
593+
594+
.cc-search-roadmap {
595+
.title {
596+
background-color: $color-lighter-gray;
597+
598+
.container {
599+
@extend .padding-horizontal-big;
600+
@extend .padding-bottom-xl;
601+
602+
.description {
603+
@extend .padding-top-normal;
604+
@extend .body-bigger;
605+
606+
line-height: 1.4375;
607+
}
608+
}
609+
}
610+
611+
.body {
612+
@extend .padding-horizontal-big;
613+
@extend .padding-top-xl;
614+
@extend .padding-bottom-xxl;
615+
@extend .body-bigger;
616+
617+
line-height: 1.8125;
618+
619+
li:before {
620+
content: "\ea02";
621+
font-family: "Vocabulary Icons";
622+
display: inline-block;
623+
font-size: 0.375rem;
624+
color: $color-gray;
625+
626+
@extend .padding-right-small;
627+
}
628+
}
629+
}

0 commit comments

Comments
 (0)