Merge branch 'main' of https://github.com/OpenTermsArchive/docs into add-local-contrib-guide

Author: Cli4d

.all-contributors.md

@@ -0,0 +1,27 @@
+This file is required by [All Contributors](https://allcontributors.org/) to work properly and must not be deleted. Although it is automatically updated with the list of contributors, the actual output used in production is in JSON format and located in the `.all-contributorsrc` file.
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://clementbiron.com/"><img src="https://avatars.githubusercontent.com/u/364319?v=4?s=100" width="100px;" alt="Clément Biron"/><br /><sub><b>Clément Biron</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=clementbiron" title="Code">💻</a> <a href="https://github.com/OpenTermsArchive/docs/commits?author=clementbiron" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ndpnt"><img src="https://avatars.githubusercontent.com/u/1098708?v=4?s=100" width="100px;" alt="Nicolas Dupont"/><br /><sub><b>Nicolas Dupont</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=Ndpnt" title="Code">💻</a> <a href="https://github.com/OpenTermsArchive/docs/commits?author=Ndpnt" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://mattischneider.fr/"><img src="https://avatars.githubusercontent.com/u/222463?v=4?s=100" width="100px;" alt="Matti Schneider"/><br /><sub><b>Matti Schneider</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=MattiSG" title="Code">💻</a> <a href="https://github.com/OpenTermsArchive/docs/commits?author=MattiSG" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://bit.ly/work-with-martin"><img src="https://avatars.githubusercontent.com/u/4191809?v=4?s=100" width="100px;" alt="Martin Ratinaud"/><br /><sub><b>Martin Ratinaud</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=martinratinaud" title="Code">💻</a> <a href="https://github.com/OpenTermsArchive/docs/commits?author=martinratinaud" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/emmanuellar"><img src="https://avatars.githubusercontent.com/u/41474439?v=4?s=100" width="100px;" alt="Amarachi Johnson-Ubah"/><br /><sub><b>Amarachi Johnson-Ubah</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=emmanuellar" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://antonin.one/"><img src="https://avatars.githubusercontent.com/u/30950182?v=4?s=100" width="100px;" alt="Antonin Del Fabbro"/><br /><sub><b>Antonin Del Fabbro</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=AntoninDelFabbro" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://md.engineer/"><img src="https://avatars.githubusercontent.com/u/15629602?v=4?s=100" width="100px;" alt="Stanley Ndagi"/><br /><sub><b>Stanley Ndagi</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=NdagiStanley" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Cli4d"><img src="https://avatars.githubusercontent.com/u/56266330?v=4?s=100" width="100px;" alt="Clifford Ouma"/><br /><sub><b>Clifford Ouma</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=Cli4d" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Aysha-py"><img src="https://avatars.githubusercontent.com/u/64032658?v=4?s=100" width="100px;" alt="Aysha Muhammed"/><br /><sub><b>Aysha Muhammed</b></sub></a><br /><a href="https://github.com/OpenTermsArchive/docs/commits?author=Aysha-py" title="Documentation">📖</a> <a href="#promotion-Aysha-py" title="Promotion">📣</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

.all-contributorsrc

@@ -0,0 +1,99 @@
+{
+  "projectName": "docs",
+  "projectOwner": "OpenTermsArchive",
+  "files": [
+    ".all-contributors.md"
+  ],
+  "contributors": [
+    {
+      "login": "clementbiron",
+      "name": "Clément Biron",
+      "avatar_url": "https://avatars.githubusercontent.com/u/364319?v=4",
+      "profile": "https://clementbiron.com/",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "Ndpnt",
+      "name": "Nicolas Dupont",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1098708?v=4",
+      "profile": "https://github.com/Ndpnt",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "MattiSG",
+      "name": "Matti Schneider",
+      "avatar_url": "https://avatars.githubusercontent.com/u/222463?v=4",
+      "profile": "https://mattischneider.fr/",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "martinratinaud",
+      "name": "Martin Ratinaud",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4191809?v=4",
+      "profile": "http://bit.ly/work-with-martin",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "emmanuellar",
+      "name": "Amarachi Johnson-Ubah",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41474439?v=4",
+      "profile": "https://github.com/emmanuellar",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "AntoninDelFabbro",
+      "name": "Antonin Del Fabbro",
+      "avatar_url": "https://avatars.githubusercontent.com/u/30950182?v=4",
+      "profile": "https://antonin.one/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "NdagiStanley",
+      "name": "Stanley Ndagi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15629602?v=4",
+      "profile": "https://md.engineer/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Cli4d",
+      "name": "Clifford Ouma",
+      "avatar_url": "https://avatars.githubusercontent.com/u/56266330?v=4",
+      "profile": "https://github.com/Cli4d",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Aysha-py",
+      "name": "Aysha Muhammed",
+      "avatar_url": "https://avatars.githubusercontent.com/u/64032658?v=4",
+      "profile": "https://github.com/Aysha-py",
+      "contributions": [
+        "doc",
+        "promotion"
+      ]
+    }
+  ],
+  "repoType": "github",
+  "commitConvention": "none",
+  "contributorsPerLine": 7,
+  "commitType": "docs"
+}

.eslintrc.yaml

@@ -46,7 +46,7 @@ rules:
   object-curly-newline:
     - error
     - multiline: true
-  no-console: 0
+  no-console: error
   no-continue: 0
   no-param-reassign: 0
   no-plusplus: 0
@@ -88,3 +88,6 @@ rules:
   new-cap:
     - error
     - properties: false
+  import/no-extraneous-dependencies:
+    - error
+    - devDependencies: true

.github/workflows/gh-pages.yml

@@ -5,6 +5,7 @@ on:
     types: [ "engine-release" ]
   push:
     branches: [ main ]
+  workflow_dispatch:
 
 jobs:
   test:

.github/workflows/test.yml

@@ -32,5 +32,3 @@ jobs:
         run: npm run build
       - name: Build JSDoc
         run: npm run jsdoc
-      - name: Test broken links
-        run: npm run test:links

.jsdoc.json

@@ -3,6 +3,9 @@
     "include": [
       "./node_modules/@opentermsarchive/engine/src/",
       "./node_modules/@opentermsarchive/engine/scripts/"
+    ],
+    "exclude": [
+      "./node_modules/@opentermsarchive/engine/src/api"
     ]
   },
   "opts": {

.markdownlint.yml

@@ -26,3 +26,6 @@ strong-style:
 single-title:
   front_matter_title: "" # disable front matter title as a top level heading, see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md025---multiple-top-level-headings-in-the-same-document
 
+no-emphasis-as-heading: false
+
+no-blanks-blockquote: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`[email protected]`.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing to this repository
+
+## 🚀 How to Contribute
+
+- You can check the open issues in this repository, comment to state your interest and solve them.
+- You can also open issues to suggest additions or changes to this documentation website.
+
+## 📜 Read our Code of Conduct
+
+Before you begin coding and collaborating, please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand the standards (that you are required to adhere to) for community engagement. As part of our open-source community, we hold ourselves and other contributors to a high standard of communication. As a participant and contributor to this project, you are agreeing to abide by our Code of Conduct.
+
+## 💻 Need Help?
+
+We are more than happy to help you. If you are facing problems while working on any issue, don’t hesitate to ask for help.
+
+Your contribution, no matter its size, holds immense value. We eagerly await to see the impact you'll make in our community! 🚀
+
+## List a new contributor in the Open Terms Archive website
+
+We acknowledge the efforts of our contributors by listing them on our [website](https://opentermsarchive.org) and this is made possible by the use of the [All Contributors bot](https://allcontributors.org/docs/en/bot/overview).
+
+All Contributors enables adding a contributor with a comment on an issue or pull request, without writing code. To do this, please use the [dedicated issue](https://github.com/OpenTermsArchive/docs/issues/134) on this repository.
+
+Please read the following [contributing guide](https://github.com/OpenTermsArchive/opentermsarchive.org/blob/main/CONTRIBUTING.md#list-a-new-contributor-in-the-open-terms-archive-website).

README.md

@@ -83,13 +83,7 @@ npm run lint:js -- --fix
 
 ### Check for broken links
 
-Build the site
-
-```sh
-hugo --minify
-```
-
-and run
+To check for broken links, run the following command:
 
 ```sh
 npm run test:links