1
0
mirror of https://github.com/go-task/task.git synced 2024-12-04 10:24:45 +02:00

fix: update references to website directory

This commit is contained in:
Pete Davison 2024-03-19 19:40:20 +00:00
parent 7c61a59ecb
commit 97cf02872f
8 changed files with 41 additions and 29 deletions

View File

@ -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

View File

@ -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

View File

@ -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"
}

View File

@ -1,6 +1,6 @@
<div align="center">
<a href="https://taskfile.dev">
<img src="docs/static/img/logo.svg" width="200px" height="200px" />
<img src="website/static/img/logo.svg" width="200px" height="200px" />
</a>
<h1>Task</h1>

View File

@ -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"

View File

@ -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 (

View File

@ -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

View File

@ -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: