diff --git a/.vscode/settings-sample.json b/.vscode/settings-sample.json index 42486f40..1373475c 100644 --- a/.vscode/settings-sample.json +++ b/.vscode/settings-sample.json @@ -1,15 +1,12 @@ { "yaml.schemas": { - "./website/static/schema.json": [ - "Taskfile.yml", - "tmp/**/*.yml" + "./website/src/public/schema.json": [ + "Taskfile.yml", + "Taskfile.yaml", + "taskfile.yml", + "taskfile.yaml" ] }, - "search.exclude": { - "**/versioned_docs": true, - "**/versioned_sidesbars": true, - "**/i18n": true - }, "gopls": { "formatting.local": "github.com/go-task" }, diff --git a/website/src/docs/contributing.md b/website/src/docs/contributing.md index 95555225..4e2ecc50 100644 --- a/website/src/docs/contributing.md +++ b/website/src/docs/contributing.md @@ -30,10 +30,10 @@ Studio Code][vscode-task]. you invest your time into a PR. - **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. - We call these "[experiments](./experiments/index.md)". If you're intending to work on - an experiment, then please read the - [experiments workflow](./experiments/index.md#workflow) document carefully and submit a - proposal first. + We call these "[experiments](./experiments/index.md)". If you're intending to + work on an experiment, then please read the + [experiments workflow](./experiments/index.md#workflow) document carefully and + submit a proposal first. ## 1. Setup @@ -85,12 +85,12 @@ by using `task website` (requires `nodejs` & `pnpm`). All content is written in Markdown and is located in the `website/src` 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](/docs/guide) 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.md). +When making a change, consider whether a change to the +[Usage Guide](/docs/guide) 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.md). If you added a new command or flag, ensure that you add it to the [CLI Reference](./reference/cli.md). New fields also need to be added to the @@ -168,7 +168,7 @@ If you have questions, feel free to ask them in the `#help` forum channel on our [pnpm]: https://pnpm.io/ [vitepress]: https://vitepress.dev [json-schema]: - https://github.com/go-task/task/blob/main/website/static/schema.json + https://github.com/go-task/task/blob/main/website/src/public/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]: diff --git a/website/src/docs/experiments/remote-taskfiles.md b/website/src/docs/experiments/remote-taskfiles.md index 4171ec49..88a8cc79 100644 --- a/website/src/docs/experiments/remote-taskfiles.md +++ b/website/src/docs/experiments/remote-taskfiles.md @@ -39,15 +39,15 @@ of node which you can use: ::: code-group ```text [HTTP/HTTPS] -https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml +https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml ``` ```text [Git over HTTP] -https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main +https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main ``` ```text [Git over SSH] -git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main +git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main ``` ::: @@ -56,7 +56,7 @@ git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main ### HTTP/HTTPS -`https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml` +`https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml` This is the most basic type of remote node and works by downloading the file from the specified URL. The file must be a valid Taskfile and can be of any @@ -66,7 +66,7 @@ find a valid Taskfile, an error is returned. ### Git over HTTP -`https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main` +`https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main` This type of node works by downloading the file from a Git repository over HTTP/HTTPS. The first part of the URL is the base URL of the Git repository. @@ -80,7 +80,7 @@ This is the same URL that you would use to clone the repo over HTTP. ### Git over SSH -`git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main` +`git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main` This type of node works by downloading the file from a Git repository over SSH. The first part of the URL is the user and base URL of the Git repository. This @@ -121,19 +121,19 @@ file. For example: ::: code-group ```shell [HTTP/HTTPS] -$ task --taskfile https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml +$ task --taskfile https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml task: [hello] echo "Hello Task!" Hello Task! ``` ```shell [Git over HTTP] -$ task --taskfile https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main +$ task --taskfile https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main task: [hello] echo "Hello Task!" Hello Task! ``` ```shell [Git over SSH] -$ task --taskfile git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main +$ task --taskfile git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main task: [hello] echo "Hello Task!" Hello Task! ``` @@ -152,21 +152,21 @@ the remote Taskfile will be available to run from your main Taskfile. version: '3' includes: - my-remote-namespace: https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml + my-remote-namespace: https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml ``` ```yaml [Git over HTTP] version: '3' includes: - my-remote-namespace: https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main + my-remote-namespace: https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main ``` ```yaml [Git over SSH] version: '3' includes: - my-remote-namespace: git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main + my-remote-namespace: git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main ``` ::: @@ -292,7 +292,9 @@ the `--download` flag. You can use the `--clear-cache` flag to clear all cached remote files. ## Configuration -This experiment adds a new `remote` section to the [configuration file](../reference/config.md). + +This experiment adds a new `remote` section to the +[configuration file](../reference/config.md). - **Type**: `object` - **Description**: Remote configuration settings for handling remote Taskfiles @@ -344,10 +346,10 @@ remote: - **Type**: `string` - **Default**: 0s (no cache) - **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$` -- **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', '24h') +- **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', + '24h') ```yaml remote: cache-expiry: "6h" ``` - diff --git a/website/src/docs/integrations.md b/website/src/docs/integrations.md index 5f76ad96..5c5fe31c 100644 --- a/website/src/docs/integrations.md +++ b/website/src/docs/integrations.md @@ -35,7 +35,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/website/static/schema.json) +[this file](https://github.com/go-task/task/blob/main/website/src/public/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: