Skip to content

Commit 7a87c58

Browse files
Dev-JoyADev-JoyA
committed
Aded changes from main
2 parents 4d6b22e + 992a862 commit 7a87c58

File tree

6 files changed

+55
-9
lines changed

6 files changed

+55
-9
lines changed

‎content/contributing-code/documentation-guidelines/contents.lr

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
_model: page
2+
---
3+
_template: page-with-toc.html
4+
---
5+
title: Documentation Guidelines
6+
---
7+
description: This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented.
8+
---
9+
body:
10+
11+
# Documentation guidelines
12+
13+
The purpose of this guideline is to provide a step-by-step framework for writing and maintaining high-quality documentation for Creative Commons (CC) projects. This guide covers essential sections such as project style guide Preference, Style modification, terminologies, markdown usage. Following these guidelines ensures consistency, clarity, and ease of use for all contributors and users.
14+
15+
## Style guide reference
16+
17+
For general writing style and guidelines, refer to the following upstream style guides:
18+
19+
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/)
20+
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
21+
22+
## Style preferences modifications
23+
24+
While adhering to the upstream style guides, observe the following modifications:
25+
- All acronyms must be defined on first use
26+
- Use active voice wherever possible to improve clarity and engagement.
27+
- Keep sentences concise and to the point, avoiding jargon unless necessary.
28+
29+
30+
## Terminology
31+
32+
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:
33+
34+
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works.
35+
- **Licenses**: Legal tools that allow creators to specify how their works can be used.
36+
- **Attribution**: Giving credit to the creator of a work, required by most CC licenses.
37+
38+
39+
## Markdown usage
40+
This section provides guidelines for using Markdown in documentation:
41+
- For comprehensive documentation on GitHub-flavored Markdown, refer to the [GitHub Markdown Guide](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
42+
- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown).
43+
- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands.

‎content/programs/contents.lr

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,20 @@ CC isn't currently participating in Google Season of Docs (GSoD).
2222

2323
### Google Summer of Code
2424

25-
CC is applying for participation in Google Summer of Code (GSoC) 2024.
25+
CC will apply for participation in Google Summer of Code (GSoC) 2025.
2626

2727
- [Program website](https://summerofcode.withgoogle.com/)
2828

2929
<!--
30-
- [CC's GSoC 2024 page][gsoc2024cc]
30+
- [CC's GSoC 2025 page][gsoc2025cc]
3131
32-
[gsoc2024cc]: https://summerofcode.withgoogle.com/programs/2024/organizations/creative-commons
32+
[gsoc2025cc]: https://summerofcode.withgoogle.com/programs/2025/organizations/creative-commons
3333
-->
3434

3535

3636
### Outreachy
3737

38-
CC isn't participating in the May 2024 internships.
39-
40-
CC will participate in the December 2024 internships.
38+
CC is participating in the December 2024 cohort.
4139

4240
- [Program website](https://www.outreachy.org/)
4341
- [CC's Outreachy page][outreachycc]

‎databags/repos.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@
473473
"english_name": "CC Legal Database",
474474
"featured": false,
475475
"id": 133715391,
476-
"language": "HTML",
476+
"language": "CSS",
477477
"license": {
478478
"name": "MIT License",
479479
"url": "https://github.com/creativecommons/legaldb/blob/main/LICENSE"

‎themes/vocabulary_theme/templates/layout.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!doctype html>
2+
<html lang="en">
23
<meta charset="utf-8">
34
<meta name="viewport" content="width=device-width, initial-scale=1" />
45
<link rel="shortcut icon" type="image/x-icon" href="{{ '/static/favicon.ico'|url }}">
@@ -46,7 +47,7 @@
4647
<header class="container">
4748
<nav class="navbar">
4849
<div class="navbar-brand">
49-
<a class="has-text-black" href="{{ '/'|url }}">
50+
<a class="has-text-black" href="{{ '/'|url }}" aria-label="Home">
5051
<svg
5152
class="logo margin-top-small"
5253
xmlns="http://www.w3.org/2000/svg"
@@ -79,6 +80,7 @@
7980
['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
8081
['/contributing-code/repo-labels', 'Repository Labels'],
8182
['/contributing-code/foundational-tech', 'Foundational technologies'],
83+
['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
8284
['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
8385
['/contributing-code/python-guidelines', 'Python Guidelines'],
8486
['/contributing-code/translation-guide', 'Translation Guide'],
@@ -272,3 +274,4 @@ <h5>Our work relies on you!</h5>
272274
</div>
273275
</footer>
274276
</body>
277+
</html>

‎themes/vocabulary_theme/templates/macros/authors_gravatar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
{% if post.author|length >= 2 %}
99
<img class="profile" src="/multiple-authors.jpg" alt="multiple authors image"/>
1010
{% else %}
11-
<img class="profile" src="https://secure.gravatar.com/avatar/{{ current_author.md5_hashed_email }}?size=200&d=mp" alt="gravatar" />
11+
<img class="profile" src="https://secure.gravatar.com/avatar/{{ current_author.md5_hashed_email }}?size=200&d=mp" alt="author's gravatar" />
1212
{% endif %}
1313
</figure>
1414
</header>

‎themes/vocabulary_theme/templates/page-with-toc.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ <h1>{{ this.title }}</h1>
3030
{% if (href == '/contributing-code') %}
3131
<ul>
3232
{% for href, title in [
33+
['/contributing-code/foundational-tech', 'Foundational technologies'],
3334
['/contributing-code/pr-guidelines', 'Pull Request Guidelines'],
3435
['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
3536
['/contributing-code/repo-labels', 'Repository Labels'],
37+
['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
3638
['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
3739
['/contributing-code/python-guidelines', 'Python Guidelines'],
3840
['/contributing-code/translation-guide', 'Translation Guide'],

0 commit comments

Comments
 (0)