Merge pull request #957 from go-task/faq

FAQ doc

docs/docs/changelog.md

@@ -1,6 +1,6 @@
 ---
 slug: /changelog/
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # Changelog

docs/docs/community.md

@@ -1,6 +1,6 @@
 ---
 slug: /community/
-sidebar_position: 6
+sidebar_position: 8
 ---
 
 # Community

docs/docs/contributing.md

@@ -1,6 +1,6 @@
 ---
 slug: /contributing/
-sidebar_position: 7
+sidebar_position: 9
 ---
 
 # Contributing

docs/docs/donate.md

@@ -1,6 +1,6 @@
 ---
 slug: /donate/
-sidebar_position: 10
+sidebar_position: 12
 ---
 
 # Donate

docs/docs/faq.md

@@ -0,0 +1,54 @@
+---
+slug: /faq/
+sidebar_position: 5
+---
+
+# FAQ
+
+This page contains a list of frequently asked questions about Task.
+
+- [Why won't my task update my shell environment?](#why-wont-my-task-update-my-shell-environment)
+- ['x' builtin command doesn't work on Windows](#x-builtin-command-doesnt-work-on-windows)
+
+## Why won't my task update my shell environment?
+
+This is a limitation of how shells work. Task runs as a subprocess of your
+current shell, so it can't change the environment of the shell that started it.
+This limitation is shared by other task runners and build tools too.
+
+A common way to work around this is to create a task that will generate output
+that can be parsed by your shell. For example, to set an environment variable on
+your shell you can write a task like this:
+
+```yaml
+my-shell-env:
+  cmds:
+    - echo "export FOO=foo"
+    - echo "export BAR=bar"
+```
+
+Now run `eval $(task my-shell-env)` and the variables `$FOO` and `$BAR` will be
+available in your shell.
+
+## 'x' builtin command doesn't work on Windows
+
+The default shell on Windows (`cmd` and `powershell`) do not have commands like
+`rm` and `cp` available as builtins. This means that these commands won't work.
+If you want to make your Taskfile fully cross-platform, you'll need to work
+around this limitation using one of the following methods:
+
+- Use the `{{OS}}` function to run an OS-specific script.
+- Use something like `{{if eq OS "windows"}}powershell {{end}}<my_cmd>` to
+  detect windows and run the command in Powershell directly.
+- Use a shell on Windows that supports these commands as builtins, such as [Git
+  Bash] or [WSL].
+
+We want to make improvements to this part of Task and the issues below track
+this work. Constructive comments and contributions are very welcome!
+
+- [#197](https://github.com/go-task/task/issues/197)
+- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93)
+- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97)
+
+[Git Bash]: https://gitforwindows.org/
+[WSL]: https://learn.microsoft.com/en-us/windows/wsl/install

docs/docs/releasing.md

@@ -1,6 +1,6 @@
 ---
 slug: /releasing/
-sidebar_position: 8
+sidebar_position: 10
 ---
 
 # Releasing

docs/docs/styleguide.md

@@ -1,6 +1,6 @@
 ---
 slug: /styleguide/
-sidebar_position: 5
+sidebar_position: 6
 ---
 
 # Styleguide

docs/docs/taskfile_versions.md

@@ -1,6 +1,6 @@
 ---
 slug: /taskfile-versions/
-sidebar_position: 9
+sidebar_position: 11
 ---
 
 # Taskfile Versions