Skip to content

Commit a4ab170

Browse files
committed
Merge branch 'master' into dev-updates
2 parents 7e0daf1 + bd8fc4d commit a4ab170

File tree

21 files changed

+1482
-106
lines changed

21 files changed

+1482
-106
lines changed
+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
username: ariessa
2+
---
3+
name: Ariessa Norramli
4+
---
5+
md5_hashed_email: 6ee7af2da22737fd49ce56adc226d2cb
6+
---
7+
about:
8+
Ariessa is a Google Season of Docs 2020 participant. Her project is about improving CC Catalog API Usage Guide. She is `@ariessa` on the CC Slack.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
name: cc-catalog-api
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
title: Add Query Using curl Command and Provide Response Samples
2+
---
3+
categories:
4+
cc-catalog-api
5+
gsod
6+
gsod-2020
7+
open-source
8+
community
9+
---
10+
author: ariessa
11+
---
12+
series: gsod-2020-cccatalog-api-usage-guide
13+
---
14+
pub_date: 2020-09-25
15+
---
16+
body:
17+
18+
First of all, I’m very thankful to get selected as a Google Season of Docs participant under Creative Commons. My project name is Improve CC Catalog API Usage Guide. The project aims to revamp the existing CC Catalog API documentation to include more narrative elements and increase user friendliness. As the focal point of this project will potentially be delivered before the end of the GSOD period, this project will also improve the CC Catalog API repo documentation for potential contributors. This project will also produce guidelines for contributing to documentation. For this project, my mentor is Alden Page.
19+
20+
### Week 1
21+
22+
So, the first two weeks of Google Season of Docs have passed. For the first week, I added examples to perform the query using curl command. I hit some problem with a Forbidden error. Turns out my access key got expired. My problem was solved after obtaining a new access key.
23+
24+
### Week 2
25+
26+
For the second week, I started to write response samples. It was tough as I have a hard time understanding [drf-yasg](https://github.com/axnsan12/drf-yasg), which is an automatic Swagger generator. It can produce Swagger / OpenAPI 2.0 specifications from a Django Rest Framework API. I tried to find as many examples as I could to increase my understanding. Funny, but it took me awhile to realise that drf-yasg is not made up of random letters. The DRF part stands for Django Rest Framework while YASG stands for Yet Another Swagger Generator.
27+
28+
----
29+
30+
That’s all!
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
name: GSoD 2020: Improve CC Catalog API Usage Guide

content/contributing-code/contents.lr

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ We make extensive use of issue labels to designate the priority, status and begi
3434
- **Issues without any of the above labels:**
3535
- These issues _may_ (or may not) be open for contribution.
3636
- Please add a comment asking one of the maintainers to triage the issue and label it as appropriate.
37+
38+
You can use our [Issue Finder tool](/contributing-code/issue-finder/) to find a good issue that matches your skills and familiarity with our software and community.
3739

3840
Some helpful saved searches on GitHub than can assist with finding an issue:
3941
- [issues labeled "good first issue"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+-linked%3Apr)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
_model: page
2+
---
3+
_template: issue_finder.html
4+
---
5+
title: Issue Finder
6+
---
7+
description: Welcome to the CC developer community! We're absolutely delighted to have you here. If you want to contribute but are unsure where to start, you can use this issue finder to find an issue that matches your skills and experience level.
8+
---
9+
body:
10+
11+
Welcome to the CC developer community!

content/contributing-code/repo-labels/contents.lr

+11-11
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,19 @@ The priority of an issue is based on its impact, derived from a combination of
6363
urgency and importance. This determines the importance of the issue when sprint
6464
planning or deciding which issues to tackle next.
6565

66-
- <span class="gh-label has-text-white" style="background-color: #b60205;">
66+
- <span class="gh-label priority-unfavourable">
6767
🟥 priority: critical
6868
</span>
6969
- **Description:** Must be fixed ASAP
70-
- <span class="gh-label has-text-black" style="background-color: #ff9f1c;">
70+
- <span class="gh-label priority-negative">
7171
🟧 priority: high
7272
</span>
7373
- **Description:** Stalls work on the project or its dependents
74-
- <span class="gh-label has-text-black" style="background-color: #ffcc00;">
74+
- <span class="gh-label priority-neutral">
7575
🟨 priority: medium
7676
</span>
7777
- **Description:** Not blocking but should be fixed soon
78-
- <span class="gh-label has-text-black" style="background-color: #cfda2c;">
78+
- <span class="gh-label priority-positive">
7979
🟩 priority: low
8080
</span>
8181
- **Description:** Low priority and doesn't need to be rushed
@@ -113,32 +113,32 @@ may not be ready to be worked on for a number of reasons and the maintainers
113113
must keep updating the labels as the situation evolves.
114114

115115
An issue, at the time of closing can have either the
116-
<span class="gh-label has-text-black" style="background-color: #cccccc;">
116+
<span class="gh-label status-light">
117117
🏁 status: ready for dev
118118
</span>
119119
or the
120-
<span class="gh-label has-text-black" style="background-color: #eeeeee;">
120+
<span class="gh-label status-lighter">
121121
⛔️ status: discarded
122122
</span>
123123
label based on whether it was closed with or without resolution, respectively.
124124

125-
- <span class="gh-label has-text-black" style="background-color: #cccccc;">
125+
- <span class="gh-label status-light">
126126
🏁 status: ready for dev
127127
</span>
128128
- **Description:** Ready for work
129-
- <span class="gh-label has-text-black" style="background-color: #999999;">
129+
- <span class="gh-label status-neutral">
130130
🚧 status: blocked
131131
</span>
132132
- **Description:** Blocked & therefore, not ready for work
133-
- <span class="gh-label has-text-white" style="background-color: #666666;">
133+
- <span class="gh-label status-dark">
134134
🧹 status: ticket work required
135135
</span>
136136
- **Description:** Needs more details before it can be worked on
137-
- <span class="gh-label has-text-black" style="background-color: #eeeeee;">
137+
- <span class="gh-label status-lighter">
138138
⛔️ status: discarded
139139
</span>
140140
- **Description:** Will not be worked on
141-
- <span class="gh-label has-text-white" style="background-color: #333333;">
141+
- <span class="gh-label status-darker">
142142
🚦 status: awaiting triage
143143
</span>
144144
- **Description:** Has not been triaged & therefore, not ready for work

0 commit comments

Comments
 (0)