diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index dd425294..fe799c0d 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -40,4 +40,4 @@ jobs: run: python -m pip install 'check-jsonschema==0.27.3' - name: check-jsonschema (metaschema) - run: check-jsonschema --check-metaschema docs/static/schema.json + run: check-jsonschema --check-metaschema website/static/schema.json diff --git a/.github/workflows/upload-source-documents.yml b/.github/workflows/upload-source-documents.yml index 4f649325..cc39881f 100644 --- a/.github/workflows/upload-source-documents.yml +++ b/.github/workflows/upload-source-documents.yml @@ -19,10 +19,10 @@ jobs: uses: tj-actions/changed-files@v41 with: files: | - docs/docs - docs/blog - docs/i18n/en - docs/src/pages + website/docs + website/blog + website/i18n/en + website/src/pages - name: Install Task uses: arduino/setup-task@v1 @@ -35,4 +35,4 @@ jobs: run: task crowdin:push env: CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} - working-directory: ./docs + working-directory: ./website diff --git a/.vscode/settings-sample.json b/.vscode/settings-sample.json index 758c94d1..42486f40 100644 --- a/.vscode/settings-sample.json +++ b/.vscode/settings-sample.json @@ -1,5 +1,17 @@ { "yaml.schemas": { - "./docs/static/schema.json": "Taskfile.yml" - } + "./website/static/schema.json": [ + "Taskfile.yml", + "tmp/**/*.yml" + ] + }, + "search.exclude": { + "**/versioned_docs": true, + "**/versioned_sidesbars": true, + "**/i18n": true + }, + "gopls": { + "formatting.local": "github.com/go-task" + }, + "go.formatTool": "gofumpt" } diff --git a/README.md b/README.md index ecf69b7e..e136eba2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- +

Task

diff --git a/Taskfile.yml b/Taskfile.yml index c2702b76..971f4c23 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -1,10 +1,10 @@ version: '3' includes: - docs: - aliases: [d] - taskfile: ./docs - dir: ./docs + website: + aliases: [w, docs, d] + taskfile: ./website + dir: ./website vars: BIN: "{{.ROOT_DIR}}/bin" diff --git a/cmd/release/main.go b/cmd/release/main.go index d97cdc44..15a5b6f9 100644 --- a/cmd/release/main.go +++ b/cmd/release/main.go @@ -15,9 +15,9 @@ import ( const ( changelogSource = "CHANGELOG.md" - changelogTarget = "docs/docs/changelog.md" - docsSource = "docs/docs" - docsTarget = "docs/versioned_docs/version-latest" + changelogTarget = "website/docs/changelog.md" + docsSource = "website/docs" + docsTarget = "website/versioned_docs/version-latest" ) var ( diff --git a/website/docs/contributing.md b/website/docs/contributing.md index dbe15e6c..e05e4261 100644 --- a/website/docs/contributing.md +++ b/website/docs/contributing.md @@ -72,21 +72,21 @@ install the extension. Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally -by using `task docs` (requires `nodejs` & `yarn`). All content is written in -Markdown and is located in the `docs/docs` directory. All Markdown documents +by using `task website` (requires `nodejs` & `yarn`). All content is written in +Markdown and is located in the `website/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). -When making a change, consider whether a change to the [Usage -Guide](/usage) is necessary. This document contains descriptions and -examples of how to use Task features. If you're adding a new feature, try to -find an appropriate place to add a new section. If you're updating an existing -feature, ensure that the documentation and any examples are up-to-date. Ensure -that any examples follow the [Taskfile Styleguide](/styleguide). +When making a change, consider whether a change to the [Usage Guide](/usage) is +necessary. This document contains descriptions and examples of how to use Task +features. If you're adding a new feature, try to find an appropriate place to +add a new section. If you're updating an existing feature, ensure that the +documentation and any examples are up-to-date. Ensure that any examples follow +the [Taskfile Styleguide](/styleguide). If you added a new field, command or flag, ensure that you add it to the -[API Reference](/api). New fields also need to be added to the -[JSON Schema][json-schema]. The descriptions for fields in the API reference and -the schema should match. +[API Reference](/api). New fields also need to be added to the [JSON +Schema][json-schema]. The descriptions for fields in the API reference and the +schema should match. ### Writing tests @@ -157,7 +157,7 @@ If you have questions, feel free to ask them in the `#help` forum channel on our [nodejs]: https://nodejs.org/en/ [yarn]: https://yarnpkg.com/ [docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json +[json-schema]: https://github.com/go-task/task/blob/main/website/static/schema.json [task-open-issues]: https://github.com/go-task/task/issues [vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues [good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 diff --git a/website/docs/integrations.md b/website/docs/integrations.md index 2e15da29..3f2364c8 100644 --- a/website/docs/integrations.md +++ b/website/docs/integrations.md @@ -32,7 +32,7 @@ To get autocompletion and validation for your Taskfile, see the This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in -[this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) +[this file](https://github.com/go-task/task/blob/main/website/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: