diff --git a/public/images/edit-this-page.png b/src/assets/edit-this-page.png similarity index 100% rename from public/images/edit-this-page.png rename to src/assets/edit-this-page.png diff --git a/public/images/translating-xpath.png b/src/assets/translating-xpath.png similarity index 100% rename from public/images/translating-xpath.png rename to src/assets/translating-xpath.png diff --git a/src/content/docs/cli/configuration.md b/src/content/docs/cli/configuration.md index 87871b15..dbbb2d38 100644 --- a/src/content/docs/cli/configuration.md +++ b/src/content/docs/cli/configuration.md @@ -4,4 +4,4 @@ title: CLI Configuration sidebar_label: Configuration --- -> Please refer to this [documentation for the configuration](../bot/configuration). +Please refer to the [bot documentation for CLI configuration information](../../bot/configuration). diff --git a/src/content/docs/cli/installation.md b/src/content/docs/cli/installation.mdx similarity index 61% rename from src/content/docs/cli/installation.md rename to src/content/docs/cli/installation.mdx index d692b707..891697a7 100644 --- a/src/content/docs/cli/installation.md +++ b/src/content/docs/cli/installation.mdx @@ -1,20 +1,19 @@ --- id: installation -title: CLI Installation +title: All-Contributors CLI Installation sidebar_label: Installation --- +import { Aside } from '@astrojs/starlight/components'; -## 1. Install the CLI tool +| [![NPM Version](https://img.shields.io/npm/v/all-contributors-cli.svg)](https://www.npmjs.com/package/all-contributors-cli) | [![AUR Version](https://img.shields.io/aur/version/all-contributors-cli.svg)](https://aur.archlinux.org/packages/all-contributors-cli) | +| --- | --- | - - NPM Version - - - AUR Version - +## 1. How to Install the All-Contributors CLI tool -This module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and -should be installed as one of your project's `devDependencies`: +The all-contributors CLI module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and +should be installed as one of your project's `devDependencies`. + +To install it run: ```console npm i -D all-contributors-cli @@ -23,7 +22,9 @@ npm i -D all-contributors-cli Alternatively, Arch Linux users can install the [`all-contributors-cli`](https://aur.archlinux.org/packages/all-contributors-cli) package from the AUR. -> The CLI is node-based, if you don't wish to add a node dependency use the [@all-contributors bot 🤖](../bot/overview) + ## 2. Init the Project @@ -65,13 +66,8 @@ For example: } ``` -To allow shortcuts such as: +To support shortcuts such as: ```console npx contributors:add jfmengels doc ``` - -## What's next - -- [Using the CLI](usage) -- [Configuring the CLI](configuration) diff --git a/src/content/docs/cli/overview.md b/src/content/docs/cli/overview.md index 8cb54dbd..350259bf 100644 --- a/src/content/docs/cli/overview.md +++ b/src/content/docs/cli/overview.md @@ -1,23 +1,19 @@ --- id: overview -title: CLI Overview +title: All-Contributors Command Line Overview sidebar_label: Overview --- - - NPM Version - -Star +| [![NPM Version](https://img.shields.io/npm/v/all-contributors-cli.svg)](https://www.npmjs.com/package/all-contributors-cli) | [![GitHub Stars](https://img.shields.io/github/stars/all-contributors/all-contributors-cli?style=social)](https://github.com/all-contributors/all-contributors-cli) | +| --- | --- | -## The problem +## About the the All-Contributors Command Line Interface (CLI) -You want to implement the [All Contributors](../specification) spec, but don't -want to maintain the table by hand +The all-contributors-cli is a tool that helps you automate adding contributor acknowledgements for your GitHub or GitLab repository at the command line. THe GitHub bot allows you to call our bot in a issue or pull request. -## The CLI solution +You want to use the command line because: +- You want to add contributors in bulk +- You want to add contributors as part of your project scripts +- You want to add contributors as part of your continuous integration (CI) process -The all-contributors-cli is a tool to help automate adding contributor acknowledgements for your GitHub or GitLab repository. - -- [Installing the CLI](installation) -- [Using the CLI](usage) -- [Configuring the CLI](configuration) +Similar to the bot, the CLI allows you to implement the [All Contributors](../specification) spec, without maintaining the contributor table by hand. diff --git a/src/content/docs/cli/usage.md b/src/content/docs/cli/usage.mdx similarity index 52% rename from src/content/docs/cli/usage.md rename to src/content/docs/cli/usage.mdx index ee0baf4a..dfba29af 100644 --- a/src/content/docs/cli/usage.md +++ b/src/content/docs/cli/usage.mdx @@ -1,26 +1,32 @@ --- id: usage -title: CLI Usage +title: Using the All-Contributors CLI sidebar_label: Usage --- +import { Aside } from '@astrojs/starlight/components'; -> This usage documentation assumes you have already followed the [cli installation steps](installation). + -A quick note: Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `npx all-contributors-cli init` route a try 😺. -## Commands - - +## All-Contributors Command Line Interface Commands ### `all-contributors init` -Run this when you first start using the all-contributors-cli. This command asks a few questions and sets up the project for all-contributors. -This setup includes creating a `.all-contributorsrc` configuration file and creating a contributor table in the `files` you specify (usually your `README.md`). +You can run `all-contributors init` when you first start using the All-Contributors CLI. This command asks a you few questions. It then, sets up the project to support All-Contributors. + +The setup includes creating: +* an `.all-contributorsrc` configuration file and +* a contributor table in the `files` you specify. + +The default file for the contributor table is your `README.md`. ### `all-contributors add` -Use `add` to add new contributors to your project, or add new ways in which they -have contributed. They will be added to your configuration file, and the +Use the `add` command to add: +* new contributors to your project, or +* add new ways in which they have contributed. + +For instance, a user may have already contributed code, but after they add a documentation pull request you might want to add them for documentation too. The contributor will be added to your configuration file, and the contributors file will be updated just as if you used the [generate command](#all-contributors-generate). ```console @@ -31,10 +37,10 @@ all-contributors add jfmengels code,doc ``` Where `username` is the user's GitHub or Gitlab username, and `contribution` is a -`,`-separated list of contributions. See the [Emoji Key (Contribution Types Reference)](../emoji-key) +`,`-separated list of contributions. See the [Emoji Key (Contribution Types Reference)](../../emoji-key) for a list of valid `contribution` types. -> **GitLab Users**: See the [additional requirements for GitLab users](#gitlab-users) + ### `all-contributors check` @@ -42,8 +48,7 @@ Use `check` to compare contributors from GitHub with the ones credited in your `.all-contributorsrc` file, to make sure that credit is given where it's due. -> Due to GitHub API restrictions, this command only works for projects with less -> than 500 contributors (Unless you set a `PRIVATE_TOKEN` as mentioned [below in GitHub users](#github-users)). + ### `all-contributors generate` @@ -73,17 +78,13 @@ In some cases you may see the error message `GitHub API rate limit exceeded for ## GitLab Users Please note that if you are using a self-hosted GitLab instance, -some commands will need you to set an environment variable named `PRIVATE_TOKEN` first. +some commands will require you to set an environment variable named `PRIVATE_TOKEN` first. -> Private token is the personal access token to authenticate with the GitLab API. + ```console # set private token on Linux export PRIVATE_TOKEN=your_private_token # set private token on Windows set PRIVATE_TOKEN=your_private_token -``` - -## What's next - -- [Configuring the CLI](configuration) +``` \ No newline at end of file diff --git a/src/content/docs/project/code-of-conduct.md b/src/content/docs/project/code-of-conduct.md index ab3f0883..bfdac9a1 100644 --- a/src/content/docs/project/code-of-conduct.md +++ b/src/content/docs/project/code-of-conduct.md @@ -59,7 +59,12 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at . All +reported by contacting the project team. + +We are currently working on a new COC team here at All Contributors so please bare with us as we rework our documentation and governance structures. + + +All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality concerning the reporter of an incident. diff --git a/src/content/docs/project/contribute.md b/src/content/docs/project/contribute.mdx similarity index 72% rename from src/content/docs/project/contribute.md rename to src/content/docs/project/contribute.mdx index 051cb19c..a32b7b9b 100644 --- a/src/content/docs/project/contribute.md +++ b/src/content/docs/project/contribute.mdx @@ -3,8 +3,14 @@ id: contribute title: Contribute, and help us improve sidebar_label: Help us Improve --- +import { Aside } from '@astrojs/starlight/components'; +import { Picture } from "astro:assets"; +import editPage from '@assets/edit-this-page.png'; +import translating from '@assets/translating-xpath.png'; -> Call for translators! [We're looking for translators](https://github.com/all-contributors/all-contributors/issues/143) to help translate this spec for everyone! +[![GitHub stars](https://img.shields.io/github/stars/all-contributors/all-contributors?style=social)](https://github.com/all-contributors/all-contributors) + + ## Help improve the all-contributors documentation! @@ -20,12 +26,14 @@ If you're not used to it or are afraid to mistype a commit, you can run `npm run ## Editing Content -> **Pro Tip**: Every page has an _Edit_ button up the top, clicking this will take you straight to the GitHub source code for that page + Once on a file, click the 'pencil' icon to [easily edit the file inline](https://help.github.com/articles/editing-files-in-your-repository/) -
- Example on how to edit a page -
+After making your changes, scroll to the bottom of the page to create a commit with your changes. You will want to create and commit these changes on a new branch in your fork of the repository. + +After committing your changes, you can create a pull request to propose your changes to be merged into the main branch. + + ## Translations @@ -35,7 +43,8 @@ Our translations are managed through crowdin. You can help contribute by heading If you like, [comment on this issue](https://github.com/all-contributors/all-contributors/issues/143) to let us know you're helping or if you have any queries! > When translating, anything that has the [XPATH](https://developer.mozilla.org/en-US/docs/Web/XPath) `@href`, `@src` etc mustn't be translated. Things like `code` should not be either. This will cause the project to 404. See the below image for an example: -Contribute to translating + + > However, it's recommended to translate any content that would contribute to a better comprehension like the comments in `code` tags _as long as_ it doesn't change the actual code since it only understands English. @@ -56,11 +65,7 @@ If you like, [comment on this issue](https://github.com/all-contributors/all-con ### Change deployments -After you translate strings in any given language, you won't see those changes appearing live until the `master` branch was updated followed by a successful deployment. - -## Search - -Search is by algolia, the configuration is at +After you translate strings in any given language, you won't see those changes appearing live until the `main` branch was updated followed by a successful deployment. ## Run the website locally: @@ -95,22 +100,16 @@ Once you have completed the above, you can launch a server locally that will bui ### Make changes - linting your contribution If you make changes to a markdown file in the site, then our linting action will -check those changes. To run the linter yourself on a file locally: - -First install markdownlint-cli: +check those changes. To run the linter yourself locally on the documentation before submitting a PR use: -`npm i -g markdownlint-cli` +`npm run lint` -Then run markdownlint on the file (or files) that you wish to check: +You can also run it manually on specific files like this: `markdownlint --fix "src/content/docs/contribute.md"` -Or you can run it on all files in the docs directory, like this: - -`markdownlint --fix "src/content/docs/**.md"` - ## Add yourself as a contributor -To add yourself to the table of contributors, follow the [bot usage instructions](../bot/usage) ;). +To add yourself to the table of contributors, follow the [bot usage instructions](../../bot/usage). [the crowdin project]: https://crowdin.com/project/all-contributors