Skip to content
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

Add capabilities to task drivers' pages #8476

Merged
merged 2 commits into from
Jul 21, 2020

Conversation

kobayashi
Copy link
Contributor

This add table of capabilities to each task driver page. #8402

@hashicorp-cla
Copy link

hashicorp-cla commented Jul 20, 2020

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this contribution @kobayashi! I took a look at the preview deploys (ex. docker) and the layout looks great.

Can you provide a sentence with a link to the API docs at the top of each capabilities section? Maybe something like:

The X task driver implements the following capabilities

And then for the Implementation side of the table, we'd rather have a plain English version of the enums. So for example, instead of FSIsolationImage, just image is fine. These are operator docs rather than plugin developer docs, so having that is a little more user-friendly.

@tgross tgross added the theme/docs Documentation issues and enhancements label Jul 21, 2020
| Feature | Implementation |
| --- | --- |
| Exec | false |
| FSIsolation | FSIsolationNone |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| --- | --- |
| SendSignals | true |
| Exec | true |
| FSIsolation | FSIsolationImage |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| SendSignals | true |
| Exec | true |
| FSIsolation | FSIsolationImage |
| NetIsolationModes | NetIsolationModeHost, NetIsolationmodeGroup |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should include MustInitiateNetwork | false everywhere it's not explicitly set to true by default.

| SendSignals | false |
| Exec | false |
| FSIsolation | FSIsolationImage |
| MountConfigs | MountConfigSupportNone |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should include | NetIsolationModes | none | here

@kobayashi
Copy link
Contributor Author

Thank you for the review @tgross !
I just modified tables.

@kobayashi kobayashi requested a review from tgross July 21, 2020 17:32
Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
theme/docs Documentation issues and enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants