From cb302953445c6773d03dbd6fe72c1d534a43e3a7 Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 16:48:47 -0500 Subject: [PATCH 1/7] translation: first pass --- .circleci/config.yml | 9 +++++++++ .gitignore | 2 +- CONTRIBUTING.md | 4 ++++ package.json | 3 +++ 4 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 7b61b15..20689a2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -50,11 +50,20 @@ jobs: - add_ssh_keys: fingerprints: - "17:59:4f:3f:42:ec:3c:e0:9f:55:88:c7:4d:b8:30:70" + - run: + name: Install crowdin + command: | + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb - run: name: Setup git user and deploy website command: | git config --global user.email "circleci-all-contributors-website@users.noreply.github.com" git config --global user.name "CircleCI All Contributors Website" + - yarn write-translation + - yarn crowdin-upload + - yarn crowdin-download CUSTOM_COMMIT_MESSAGE="[skip ci]" USE_SSH=true yarn publish-gh-pages workflows: diff --git a/.gitignore b/.gitignore index 9c16393..a2ce24e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ node_modules website/build -i18n +website/i18n yarn-error.log diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 974a977..d861f8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,8 @@ # Contributing Docs + +## Translations +Translations by crowdin: https://crowdin.com/project/all-contributors/settings#files + ## Search Search is by algolia, configuration is at /~https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json diff --git a/package.json b/package.json index 7851a23..e3c2c3c 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,9 @@ "scripts": { "start": "cd website && ../node_modules/.bin/docusaurus-start", "build": "cd website && ../node_modules/.bin/docusaurus-build", + "write-translation": "cd website && ../node_modules/.bin/docusaurus-write-translations", + "crowdin-upload": "crowdin --config crowdin.yaml upload sources --auto-update -b master", + "crowdin-download": "crowdin --config crowdin.yaml download -b master", "publish-gh-pages": "cd website && ../node_modules/.bin/docusaurus-publish", "commit": "npx git-cz" }, From e1320f2172d0d80cc6fe2592cab0ce6f8430016f Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 16:48:52 -0500 Subject: [PATCH 2/7] translation: first pass --- crowdin.yaml | 20 ++ website/languages.js | 181 +++++++++++++++++++ website/pages/todo/help-with-translations.js | 69 +++++++ 3 files changed, 270 insertions(+) create mode 100755 crowdin.yaml create mode 100755 website/languages.js create mode 100755 website/pages/todo/help-with-translations.js diff --git a/crowdin.yaml b/crowdin.yaml new file mode 100755 index 0000000..62f2d2d --- /dev/null +++ b/crowdin.yaml @@ -0,0 +1,20 @@ +project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID +api_key_env: CROWDIN_DOCUSAURUS_API_KEY +base_path: "./" +preserve_hierarchy: true + +files: + - + source: '/docs/*.md' + translation: '/website/translated_docs/%locale%/%original_file_name%' + languages_mapping: &anchor + locale: + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ko': 'ko' + 'pt-BR': 'pt-BR' + + - + source: '/website/i18n/en.json' + translation: '/website/i18n/%locale%.json' + languages_mapping: *anchor diff --git a/website/languages.js b/website/languages.js new file mode 100755 index 0000000..ed962c7 --- /dev/null +++ b/website/languages.js @@ -0,0 +1,181 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const languages = [ + { + enabled: true, + name: 'English', + tag: 'en', + }, + { + enabled: false, + name: '日本語', + tag: 'ja', + }, + { + enabled: false, + name: 'العربية', + tag: 'ar', + }, + { + enabled: false, + name: 'Bosanski', + tag: 'bs-BA', + }, + { + enabled: false, + name: 'Català', + tag: 'ca', + }, + { + enabled: false, + name: 'Čeština', + tag: 'cs', + }, + { + enabled: false, + name: 'Dansk', + tag: 'da', + }, + { + enabled: false, + name: 'Deutsch', + tag: 'de', + }, + { + enabled: false, + name: 'Ελληνικά', + tag: 'el', + }, + { + enabled: true, + name: 'Español', + tag: 'es-ES', + }, + { + enabled: false, + name: 'فارسی', + tag: 'fa-IR', + }, + { + enabled: false, + name: 'Suomi', + tag: 'fi', + }, + { + enabled: true, + name: 'Français', + tag: 'fr', + }, + { + enabled: false, + name: 'עִברִית', + tag: 'he', + }, + { + enabled: false, + name: 'Magyar', + tag: 'hu', + }, + { + enabled: false, + name: 'Bahasa Indonesia', + tag: 'id-ID', + }, + { + enabled: false, + name: 'Italiano', + tag: 'it', + }, + { + enabled: false, + name: 'Afrikaans', + tag: 'af', + }, + { + enabled: true, + name: '한국어', + tag: 'ko', + }, + { + enabled: false, + name: 'मराठी', + tag: 'mr-IN', + }, + { + enabled: false, + name: 'Nederlands', + tag: 'nl', + }, + { + enabled: false, + name: 'Norsk', + tag: 'no-NO', + }, + { + enabled: false, + name: 'Polskie', + tag: 'pl', + }, + { + enabled: false, + name: 'Português', + tag: 'pt-PT', + }, + { + enabled: true, + name: 'Português (Brasil)', + tag: 'pt-BR', + }, + { + enabled: false, + name: 'Română', + tag: 'ro', + }, + { + enabled: false, + name: 'Русский', + tag: 'ru', + }, + { + enabled: false, + name: 'Slovenský', + tag: 'sk-SK', + }, + { + enabled: false, + name: 'Српски језик (Ћирилица)', + tag: 'sr', + }, + { + enabled: false, + name: 'Svenska', + tag: 'sv-SE', + }, + { + enabled: false, + name: 'Türkçe', + tag: 'tr', + }, + { + enabled: false, + name: 'Українська', + tag: 'uk', + }, + { + enabled: false, + name: 'Tiếng Việt', + tag: 'vi', + }, + { + enabled: false, + name: '中文', + tag: 'zh-CN', + }, + {enabled: false, name: '繁體中文', tag: 'zh-TW'}, +]; +module.exports = languages; diff --git a/website/pages/todo/help-with-translations.js b/website/pages/todo/help-with-translations.js new file mode 100755 index 0000000..19dbc9c --- /dev/null +++ b/website/pages/todo/help-with-translations.js @@ -0,0 +1,69 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +const translate = require('../../server/translate.js').translate; + +class Help extends React.Component { + render() { + const supportLinks = [ + { + content: ( + + Learn more using the [documentation on this + site.](/test-site/docs/en/doc1.html) + + ), + title: Browse Docs, + }, + { + content: ( + + Ask questions about the documentation and project + + ), + title: Join the community, + }, + { + content: Find out what's new with this project, + title: Stay up to date, + }, + ]; + + return ( +
+ +
+
+

+ Need help? +

+
+

+ + This project is maintained by a dedicated group of people. + +

+ +
+ +
+ ); + } +} + +Help.defaultProps = { + language: 'en', +}; + +module.exports = Help; From 3b466ada4a64c0afd79684a5b74b84b783ecf87f Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 17:06:14 -0500 Subject: [PATCH 3/7] brew --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d861f8a..9750375 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,7 @@ ## Translations +Locally you need the crowdin CLI tool: `brew install crowdin` Translations by crowdin: https://crowdin.com/project/all-contributors/settings#files ## Search From ca6fc778cb634378bdc7b9962226e61eeea4e182 Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 18:02:16 -0500 Subject: [PATCH 4/7] docs: add translations --- .gitignore | 1 + crowdin.yaml | 6 +++--- docs/bot/configuration.md | 4 ++-- docs/bot/installation.md | 12 ++++++------ docs/bot/overview.md | 12 ++++++------ docs/bot/usage.md | 8 ++++---- docs/cli/configuration.md | 4 ++-- docs/cli/installation.md | 10 +++++----- docs/cli/overview.md | 8 ++++---- docs/cli/usage.md | 6 +++--- docs/emoji-key.md | 6 +++--- docs/overview.md | 16 +++++++++------- docs/repository-maintainers.md | 4 ++-- docs/specification.md | 12 ++++++------ docs/tooling.md | 10 +++++----- docs/website/contribute.md | 8 +++++++- website/languages.js | 4 ++-- website/static/index.html | 4 ++-- 18 files changed, 72 insertions(+), 63 deletions(-) diff --git a/.gitignore b/.gitignore index a2ce24e..8b1350e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules website/build website/i18n +website/translated_docs yarn-error.log diff --git a/crowdin.yaml b/crowdin.yaml index 62f2d2d..07460d9 100755 --- a/crowdin.yaml +++ b/crowdin.yaml @@ -5,14 +5,14 @@ preserve_hierarchy: true files: - - source: '/docs/*.md' - translation: '/website/translated_docs/%locale%/%original_file_name%' + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' languages_mapping: &anchor locale: 'es-ES': 'es-ES' 'fr': 'fr' 'ko': 'ko' - 'pt-BR': 'pt-BR' + 'pt-PT': 'pt-PT' - source: '/website/i18n/en.json' diff --git a/docs/bot/configuration.md b/docs/bot/configuration.md index b5f062b..633691a 100644 --- a/docs/bot/configuration.md +++ b/docs/bot/configuration.md @@ -8,7 +8,7 @@ You can configure the all-contributors bot behaviour by updating the `.all-contr The data used to generate the contributors list will be stored in there, and you can configure how you want `@all-contributors` to generate the list. -> You are viewing the 🤖Bot Configuration, which is similar to the [CLI Configuration](/docs/cli/configuration) +> You are viewing the 🤖Bot Configuration, which is similar to the [CLI Configuration](../cli/configuration) These are the keys you can specify: @@ -20,7 +20,7 @@ These are the keys you can specify: | `badgeTemplate` | Define your own lodash template to generate the badge. | | | `contributorTemplate` | Define your own lodash template to generate the contributor. | | | `types` | Specify custom symbols or link templates for contribution types. Can override the documented types. | | -| `contributors` | List of contributors for this project, this is updated by [@all-contributors add](/docs/bot/usage#all-contributors-add) | | +| `contributors` | List of contributors for this project, this is updated by [@all-contributors add](usage#all-contributors-add) | | ```json { diff --git a/docs/bot/installation.md b/docs/bot/installation.md index baebefc..99a7bd0 100644 --- a/docs/bot/installation.md +++ b/docs/bot/installation.md @@ -9,26 +9,26 @@ sidebar_label: Installation [Install the GitHub App](/~https://github.com/apps/allcontributors/installations/new) - App Install Screenshot + App Install Screenshot ## 2. Configure your repositories -Configure Repositories Screenshot +Configure Repositories Screenshot ## 3. Create a `README.md` Ensure you have a `README.md` file in the root of the project (it can be empty). If you prefer your contributors table in a place other than the `README.md`; After merging your first bot PR, you can move your contributors table, -see `files` in the [bot configuration](/docs/bot/configuration) +see `files` in the [bot configuration](configuration) ## 4. Update your Contributing documentation -Consider updating your `CONTRIBUTING.md` or similar with steps on how contributors can add themselves. You can even link to the [bot usage documentation](/docs/bot/usage). +Consider updating your `CONTRIBUTING.md` or similar with steps on how contributors can add themselves. You can even link to the [bot usage documentation](usage). ## What's next -- [Using the Bot](/docs/bot/usage) -- [Configuring the Bot](/docs/bot/configuration) +- [Using the Bot](usage) +- [Configuring the Bot](configuration) diff --git a/docs/bot/overview.md b/docs/bot/overview.md index 1a4a00d..35af5a5 100644 --- a/docs/bot/overview.md +++ b/docs/bot/overview.md @@ -12,16 +12,16 @@ sidebar_label: Overview 🤖 A GitHub bot to automate acknowledging contributors to your open source projects. ## Motivation -Implementing the [All Contributors spec](/docs/specification) by hand is a laborious process. +Implementing the [All Contributors spec](../specification) by hand is a laborious process. Enter the `@all-contributors bot`! The bot will automatically pull a user's profile, grab the contribution type emoji, update the project README and then open a Pull Request against the project - - Example usage screenshot + + Example usage screenshot -- [Installing the Bot](/docs/bot/installation) -- [Using the Bot](/docs/bot/usage) -- [Configuring the Bot](/docs/bot/configuration) +- [Installing the Bot](installation) +- [Using the Bot](sage) +- [Configuring the Bot](configuration) diff --git a/docs/bot/usage.md b/docs/bot/usage.md index cc82e63..6ff416b 100644 --- a/docs/bot/usage.md +++ b/docs/bot/usage.md @@ -4,7 +4,7 @@ title: Bot Usage sidebar_label: Usage --- -> This usage documentation assumes you have already followed the [bot installation steps](/docs/bot/installation). +> This usage documentation assumes you have already followed the [bot installation steps](installation). ## Commands @@ -15,11 +15,11 @@ sidebar_label: Usage ``` @all-contributors please add for ``` -**\**: See the [Emoji Key (Contribution Types Reference)](/docs/emoji-key) for a list of valid `contribution` types. +**\**: See the [Emoji Key (Contribution Types Reference)](../emoji-key) for a list of valid `contribution` types. The bot will then create a Pull Request to add the contributor, then reply with the pull request details. -Example usage screenshot +Example usage screenshot > Your request to the bot doesn't need to be perfect. The bot will use [basic Natural Language Parsing](/~https://github.com/all-contributors/all-contributors-bot/blob/master/src/tasks/processIssueComment/utils/parse-comment/index.js) to determine your intent. > For example, this will work too: @@ -27,4 +27,4 @@ The bot will then create a Pull Request to add the contributor, then reply with > `Jane you are crushing it in documentation and your infrastructure work has been great too. Let's add jane.doe23 for her contributions. cc @all-contributors` ## What's next -- [Configuring the Bot](/docs/bot/configuration) +- [Configuring the Bot](configuration) diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 7dea7f8..548dcfe 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -8,7 +8,7 @@ You can configure all-contributors by updating the `.all-contributorsrc` JSON fi The data used to generate the contributors list will be stored in there, and you can configure how you want `all-contributors-cli` to generate the list. -> You are viewing the CLI Configuration, are you looking for the [Bot Configuration](/docs/bot/configuration)? +> You are viewing the CLI Configuration, are you looking for the [Bot Configuration](../bot/configuration)? These are the keys you can specify: @@ -25,7 +25,7 @@ These are the keys you can specify: | `badgeTemplate` | Define your own lodash template to generate the badge. | | | `contributorTemplate` | Define your own lodash template to generate the contributor. | | | `types` | Specify custom symbols or link templates for contribution types. Can override the documented types. | | -| `contributors` | List of contributors for this project, this is updated by [all-contributors add](/docs/cli/usage#all-contributors-add) | | +| `contributors` | List of contributors for this project, this is updated by [all-contributors add](usage#all-contributors-add) | | ```json { "projectName": "all-contributors-cli", diff --git a/docs/cli/installation.md b/docs/cli/installation.md index dd7b4cf..0b48d67 100644 --- a/docs/cli/installation.md +++ b/docs/cli/installation.md @@ -17,7 +17,7 @@ should be installed as one of your project's `devDependencies`: yarn add --dev all-contributors-cli # or npm ``` -> The CLI is node based, if you don't wish to add a node depdendency use the [@all-contributors bot 🤖](/docs/bot/overview) +> The CLI is node based, if you don't wish to add a node depdendency use the [@all-contributors bot 🤖](../bot/overview) ## 2. Init the Project @@ -35,11 +35,11 @@ yarn all-contributors init # npm run yarn all-contributors add jfmengels doc yarn all-contributors generate ``` -For more on the commands see [CLI usage](/docs/cli/usage) +For more on the commands see [CLI usage](usage) ## 4. Update your Contributing documentation -Consider updating your `CONTRIBUTING.md` or similar with steps on how your contributors can add themselves. You can even link to the [cli usage documentation](/docs/cli/usage). +Consider updating your `CONTRIBUTING.md` or similar with steps on how your contributors can add themselves. You can even link to the [cli usage documentation](usage). ## 5. *Optionally* add shortcut scripts to your `package.json` @@ -62,6 +62,6 @@ yarn contributors:add jfmengels doc ## What's next -- [Using the CLI](/docs/cli/usage) -- [Configuring the CLI](/docs/cli/configuration) +- [Using the CLI](usage) +- [Configuring the CLI](configuration) diff --git a/docs/cli/overview.md b/docs/cli/overview.md index 1136b1e..01c8d9b 100644 --- a/docs/cli/overview.md +++ b/docs/cli/overview.md @@ -12,13 +12,13 @@ sidebar_label: Overview ## The problem -You want to implement the [All Contributors](/docs/specification) spec, but don't +You want to implement the [All Contributors](../specification) spec, but don't want to maintain the table by hand ## The CLI solution The all-contributors-cli is a tool to help automate adding contributor acknowledgements for your GitHub or GitLab repository. -- [Installing the CLI](/docs/cli/installation) -- [Using the CLI](/docs/cli/usage) -- [Configuring the CLI](/docs/cli/configuration) +- [Installing the CLI](installation) +- [Using the CLI](usage) +- [Configuring the CLI](configuration) diff --git a/docs/cli/usage.md b/docs/cli/usage.md index 8d44f7f..2047548 100644 --- a/docs/cli/usage.md +++ b/docs/cli/usage.md @@ -4,7 +4,7 @@ title: CLI Usage sidebar_label: Usage --- -> This usage documentation assumes you have already followed the [cli installation steps](/docs/cli/installation). +> 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 `yarn all-contributors` route a try 😺 @@ -29,7 +29,7 @@ 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)](/docs/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) @@ -76,4 +76,4 @@ set PRIVATE_TOKEN=your_private_token ## What's next -- [Configuring the CLI](/docs/cli/configuration) +- [Configuring the CLI](configuration) diff --git a/docs/emoji-key.md b/docs/emoji-key.md index d53d2b8..db29d4d 100644 --- a/docs/emoji-key.md +++ b/docs/emoji-key.md @@ -6,7 +6,7 @@ sidebar_label: Emoji Key ✨ ## Table -> To have a contribution added when using the [Bot](/docs/bot/overview) or [CLI](/docs/cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](/~https://github.com/all-contributors/all-contributors-bot/blob/master/src/tasks/processIssueComment/utils/parse-comment/index.js) to determine your contribution intent. +> To have a contribution added when using the [Bot](bot/overview) or [CLI](cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](/~https://github.com/all-contributors/all-contributors-bot/blob/master/src/tasks/processIssueComment/utils/parse-comment/index.js) to determine your contribution intent. Emoji/Type | Represents | Comments :---: | :---: | :---: @@ -40,5 +40,5 @@ Emoji/Type | Represents | Comments *N/I: These contribution types are currently not supported by tooling. ## What's next -- [Notes for repository maintainers](/docs/repository-maintainers) -- [Automating the process using tools](/docs/tooling) +- [Notes for repository maintainers](repository-maintainers) +- [Automating the process using tools](tooling) diff --git a/docs/overview.md b/docs/overview.md index c46d6a5..abd330d 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -4,8 +4,10 @@ title: Overview sidebar_label: Overview --- +> Call for translators! [We're looking for translators](/~https://github.com/all-contributors/all-contributors/issues/143) to help translate this spec for everyone! +
- ✨ All Contributors ✨ + ✨ All Contributors ✨
Star @@ -22,14 +24,14 @@ Everyone should be praised for their contributions (code or not). ## The All Contributors Table Below is an example of how using the all-contributors spec table can recognize all contributors
- All Contributors Table Screenshot + All Contributors Table Screenshot
-> You can use [the @all-contributors bot 🤖](/docs/bot/overview) to automate acknowledging contributors to your open source projects +> You can use [the @all-contributors bot 🤖](bot/overview) to automate acknowledging contributors to your open source projects ## What's next -- [The all contributors specification](/docs/specification) -- [Emoji Key (Contribution Types Reference)](/docs/emoji-key) -- [Notes for repository maintainers](/docs/repository-maintainers) -- [Automating the process using tools](/docs/tooling) +- [The all contributors specification](specification) +- [Emoji Key (Contribution Types Reference)](emoji-key) +- [Notes for repository maintainers](repository-maintainers) +- [Automating the process using tools](tooling) diff --git a/docs/repository-maintainers.md b/docs/repository-maintainers.md index 2a1155c..c6f83f2 100644 --- a/docs/repository-maintainers.md +++ b/docs/repository-maintainers.md @@ -8,7 +8,7 @@ Contributors should be recognised as soon as the contribution is discovered to h overlooked when the list gets updated at a later date. This can be difficult for contributions that are not the result of a commit to repository but do your best to minimise the time between the contribution and updating the list. -> **Pro tip:** If your project is configured for [the @all-contributors bot 🤖](/docs/bot/overview)simply write a comment on an issue or pull request to recognise their contribution. For example: +> **Pro tip:** If your project is configured for [the @all-contributors bot 🤖](bot/overview)simply write a comment on an issue or pull request to recognise their contribution. For example: > > `@all-contributors please add @tbenning for design` ✨ @@ -26,4 +26,4 @@ In the end, there are no hard and fast rules for when a contribution has to be a just do your best to be fair and to ensure all contributors are recognised. ## What's next -- [Automating the process using tools](/docs/tooling) +- [Automating the process using tools](tooling) diff --git a/docs/specification.md b/docs/specification.md index 2a0a799..e562eed 100644 --- a/docs/specification.md +++ b/docs/specification.md @@ -6,7 +6,7 @@ sidebar_label: Specification An example of how using the all-contributors spec table can recognize all contributors
- Contributors Table Screenshot + Contributors Table Screenshot
## Mandatory @@ -19,12 +19,12 @@ Open source projects should include the following mandatory items in order to su - Name - URL link to a site where more information can be learned about the contributor. This URL may be determined by the contributor at the project's discretion. - Indication of the Contribution Category in text or icon image format using the defined Contribution Categories and/or Contribution Categories emoji images (see below). - - A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or [Contribution Categories emoji](/docs/emoji-key). + - A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or [Contribution Categories emoji](emoji-key). - The list of contributors can be spread across multiple lines (each technically being its own table) as needed. - The order of contributors is immaterial to the spec. Order them how you wish. 3. Projects should define contributors as those who contribute to a project in any of the Contribution Categories at any level of contribution. This specification is, by definition, inclusive of all contributions. In cases where projects deviate from the Contribution Categories or require a specific contribution level in order to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. This specification recommends against exclusion of an individual from the Contributor list based upon perceived level of contribution. Instead, projects should use indicators of effort within a list that remains inclusive of all contributors to the project at any level of effort. If used, these effort indicators are at the discretion of the project and are not currently specified. -> **Pro tip:** You can use [the @all-contributors bot 🤖](/docs/bot/overview) to automate acknowledging contributors to your open source projects ✨ +> **Pro tip:** You can use [the @all-contributors bot 🤖](bot/overview) to automate acknowledging contributors to your open source projects ✨ ## Optional Projects should consider the following optional items as part of their commitment to the All Contributors specification: @@ -33,7 +33,7 @@ Projects should consider the following optional items as part of their commitmen 3. An optional link from the Contribution Category indicator to the category-specific contribution(s) can be included to provide additional information about the project contribution(s) as detailed in the section below. ## What's next -- [Emoji Key (Contribution Types Reference)](/docs/emoji-key) -- [Notes for repository maintainers](/docs/repository-maintainers) -- [Automating the process using tools](/docs/tooling) +- [Emoji Key (Contribution Types Reference)](emoji-key) +- [Notes for repository maintainers](repository-maintainers) +- [Automating the process using tools](tooling) diff --git a/docs/tooling.md b/docs/tooling.md index a3cba67..7ac1bdf 100644 --- a/docs/tooling.md +++ b/docs/tooling.md @@ -5,14 +5,14 @@ sidebar_label: Tooling --- ## Motivation -Implementing the [All Contributors spec](/docs/specification) by hand is a laborious process. +Implementing the [All Contributors spec](specification) by hand is a laborious process. ### All Contributors Bot -Enter the [@all-contributors bot 🤖](/docs/bot/overview)! The bot will automatically pull a user's profile, grab the contribution type emoji, update the project README and then open a Pull Request against the project ✨ - - Example usage screenshot +Enter the [@all-contributors bot 🤖](bot/overview)! The bot will automatically pull a user's profile, grab the contribution type emoji, update the project README and then open a Pull Request against the project ✨ + + Example usage screenshot ### All Contributors CLI -If you prefer command line tools there is also the [all-contributors CLI tool](/docs/cli/overview) to help automate adding contributor acknowledgements. +If you prefer command line tools there is also the [all-contributors CLI tool](cli/overview) to help automate adding contributor acknowledgements. diff --git a/docs/website/contribute.md b/docs/website/contribute.md index 996fa9e..050af03 100644 --- a/docs/website/contribute.md +++ b/docs/website/contribute.md @@ -4,6 +4,8 @@ title: Contribute, and help us improve sidebar_label: Help us Improve --- +> Call for translators! [We're looking for translators](/~https://github.com/all-contributors/all-contributors/issues/143) to help translate this spec for everyone! + ## Help improve the all-contributors documentation! Pull Requests welcome for any level of improvement, from a small typo to new section, help us make the documentation better! @@ -17,5 +19,9 @@ All the source code is available at [github.com/all-contributors/website](https: 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 + Example on how to edit a page
+ + +## Translation +Our translations are managed through crowdin. If you want to help contribute [please comment on this thread](/~https://github.com/all-contributors/all-contributors/issues/143) and I'll add you to the project diff --git a/website/languages.js b/website/languages.js index ed962c7..7f88d7f 100755 --- a/website/languages.js +++ b/website/languages.js @@ -122,12 +122,12 @@ const languages = [ tag: 'pl', }, { - enabled: false, + enabled: true, name: 'Português', tag: 'pt-PT', }, { - enabled: true, + enabled: false, name: 'Português (Brasil)', tag: 'pt-BR', }, diff --git a/website/static/index.html b/website/static/index.html index 2de89a8..03d2339 100644 --- a/website/static/index.html +++ b/website/static/index.html @@ -2,7 +2,7 @@ - + @@ -21,7 +21,7 @@ All Contributors: ✨ Recognize all contributors, not just the ones who push code ✨ From 1c9fd79db5e0bc4b1af4e2283f873b0e58f0068a Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 18:04:58 -0500 Subject: [PATCH 5/7] infra: write translations in ci --- .circleci/config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 20689a2..63e9645 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -35,6 +35,7 @@ jobs: working_directory: ~/repo steps: - prep_env + - run: yarn write-translation - run: yarn build - persist_to_workspace: root: ./ From 8b073b03692d68d2ef6aef5118309c0ad5949c1c Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 18:08:34 -0500 Subject: [PATCH 6/7] infra: drop ci for branches --- .circleci/config.yml | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 63e9645..3fd1543 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -30,17 +30,6 @@ jobs: - prep_env - run: yarn install --frozen-lockfile - save_env_cache - website: - <<: *docker_defaults - working_directory: ~/repo - steps: - - prep_env - - run: yarn write-translation - - run: yarn build - - persist_to_workspace: - root: ./ - paths: - - website/build/ deploy_website: <<: *docker_defaults working_directory: ~/repo @@ -72,9 +61,6 @@ workflows: build_and_deploy: jobs: - node_modules - - website: - requires: - - node_modules - deploy_website: requires: - website From 59e72ad2bca1f5410ec269644764d7bd88cc0d1f Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sun, 27 Jan 2019 18:09:14 -0500 Subject: [PATCH 7/7] valid --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 3fd1543..227849f 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -63,7 +63,7 @@ workflows: - node_modules - deploy_website: requires: - - website + - node_modules filters: branches: only: