Clarify that Task is not Taskwarrior
What does this MR do?
This is a tragicomedy story...
Some users prefer to manage their dependencies with brew instead of asdf. There's an older binary package called task
which is installed via brew install task
. I naively decided to use brew
instead of asdf
, so it took me ages to realize why when I would execute any task command like task --list
, I would get a successful output printing No matches.
, and I could never provision my operator with our predefined tasks, so I would end up provisioning the operator manually.
Other people have been through similar confusiong, so I feel like it deserves a small hint in our development docs. See for reference: https://github.com/go-task/task/issues/697
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Merge Request Title and Description are up to date, accurate, and descriptive -
MR targeting the appropriate branch -
MR has a green pipeline on GitLab.com -
When ready for review, MR is labeled "~workflow::ready for review" per the Distribution MR workflow
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.