-
-
Notifications
You must be signed in to change notification settings - Fork 721
feat: add config to taskrc.yml #2389
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
website/src/docs/reference/cli.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Up for debate, but I'm not convinced that these flags should be documented here. I've always seen the experiments as independent from the rest of Task and fully documented within their experiments page. This means that the main docs are stable and not changing all the time.
The intention would then be to move the experiment docs to the appropriate place when released.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get your point, but it still feels a bit odd to me that it’s in reference/config.yml
but not in cli.md
.
Personally, I think all the flags you see in task -h
should also show up in cli.md
.
Remote experiments are used a lot, and it’s not always clear which flags exist or what they actually do just from the experiment page. That’s why I suggested documenting it, but with a note like:
This flag is linked to an experiment (see XXXXX) and could be removed at any time.
That said, if you both prefer not to include it here, I’m fine with removing it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think for the config reference, I would include a section for the experiments:
key, but not include the specific experiments. Just say something along the lines of "please refer to the experiments pages for more details" and then describe the name of the key and values over there.
I don't think specific experiments should be described in any pages outside the experiments docs themselves.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what you mean but I've removed all remote and gentle force stuff from CLI.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it! Let me know if this is what you had in mind 🙂
website/src/docs/reference/cli.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree
Co-authored-by: Pete Davison <[email protected]>
Co-authored-by: Pete Davison <[email protected]>
Co-authored-by: Pete Davison <[email protected]>
remote
CLI flag (marked as experimental with a badge).gentle-force
CLI flag (marked as experimental with a badge).Fixes #1403