From fc50b846c4ec6b2cfb15d0ac01315e3e41f5bba9 Mon Sep 17 00:00:00 2001 From: Andrey Nering Date: Mon, 20 Mar 2023 22:33:24 -0300 Subject: [PATCH] CHANGELOG entry + Small adjustments to #1058 --- .../workflows/sync-translated-documents.yml | 12 ++++++----- CHANGELOG.md | 8 +++---- docs/Taskfile.yml | 6 +++++- docs/docs/translate.md | 21 +++++++++++++++++++ docs/docusaurus.config.js | 14 ++++++------- 5 files changed, 44 insertions(+), 17 deletions(-) create mode 100644 docs/docs/translate.md diff --git a/.github/workflows/sync-translated-documents.yml b/.github/workflows/sync-translated-documents.yml index 563a2f93a3..d9f4cb3e9b 100644 --- a/.github/workflows/sync-translated-documents.yml +++ b/.github/workflows/sync-translated-documents.yml @@ -24,9 +24,11 @@ jobs: - name: Create Pull Request uses: peter-evans/create-pull-request@v4 with: - commit-message: "docs: sync translated documents" - title: "docs: sync translated documents" - body: "- [x] Sync translated documents" - branch: feature/auto-sync-translated-documents + commit-message: "Website: Sync translations" + title: "Website: Sync translations" + body: Synchonizing translations with Crowdin + branch: chore/sync-translations delete-branch: true - draft: true + author: task-bot <106601941+task-bot@users.noreply.github.com> + labels: translation + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ca82fd59e..b2fe27f905 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,11 @@ ## Unreleased +- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) + to allow the community to contribute with translations! + [Chinese](https://taskfile.dev/zh-Hans/) is the first language available + ([#1057](https://github.com/go-task/task/issues/1057), [#1058](https://github.com/go-task/task/pull/1058) by @misitebao). - Added task location data to the `--json` flag output ([#1056](https://github.com/go-task/task/pull/1056) by @pd93) - -## Unreleased - - Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` ([#1062](https://github.com/go-task/task/pull/1062) by @misitebao). @@ -13,7 +14,6 @@ (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is splitted as arguments not whitespaces ([#1040](https://github.com/go-task/task/issues/1040), [#1059](https://github.com/go-task/task/pull/1059) by @dhanusaputra). -- Added task location data to the `--json` flag output ([#1056](https://github.com/go-task/task/pull/1056) by @pd93) ## v3.22.0 - 2023-03-10 diff --git a/docs/Taskfile.yml b/docs/Taskfile.yml index 69bf954edd..bd52d740be 100644 --- a/docs/Taskfile.yml +++ b/docs/Taskfile.yml @@ -28,8 +28,12 @@ tasks: preview: desc: Preview Website deps: [build] + aliases: [serve] + vars: + HOST: '{{default "localhost" .HOST}}' + PORT: '{{default "3001" .PORT}}' cmds: - - npx docusaurus serve + - npx docusaurus serve --no-open --host={{.HOST}} --port={{.PORT}} clean: desc: Clean temp directories diff --git a/docs/docs/translate.md b/docs/docs/translate.md new file mode 100644 index 0000000000..40de864006 --- /dev/null +++ b/docs/docs/translate.md @@ -0,0 +1,21 @@ +--- +slug: /translate/ +sidebar_position: 13 +--- + +# Translate + +Want to help us translate this documentation? In this document we explain how. + +Do NOT edit translated markdown files directly on the GitHub repository! +We use [Crowdin][crowdin] to allow contributors on work on translations. +The repository is periodically updated with progress from Crowdin. + +If you want to have access to the Crowdin project to be able to suggest +translations, please ask for access on the +[#translations channel on our Discord server][discord]. +If a given language is not being shown to Crowdin yet, just ask and we can +configure it. + +[crowdin]: https://crowdin.com/project/taskfile +[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 54a8bc607d..1154db60ef 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -110,13 +110,13 @@ const config = { }, { type: 'localeDropdown', - position: 'left' - // dropdownItemsAfter: [ - // { - // to: '/', - // label: 'Help Us Translate ❤' - // } - // ] + position: 'left', + dropdownItemsAfter: [ + { + to: '/translate/', + label: 'Help Us Translate' + } + ] }, { href: GITHUB_URL,