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

Added config_drive description to docs #66

Merged
merged 3 commits into from
May 29, 2020
Merged

Conversation

shimisho
Copy link
Contributor

Added description of config_drive to docs.

Copy link
Contributor

@kazyshr kazyshr left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@t-wata t-wata left a comment

Choose a reason for hiding this comment

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

I think this explanation is a little bit inadequate.
The config_drive does not simply enable a general ephemeral disk, but has the purpose of referencing metadata in particular.
Also, since this parameter is optional, it would be helpful to have a mention of the default value.

@shimisho
Copy link
Contributor Author

@t-wata Added more detailed description of config_drive. Please confirm.

Copy link

@t-wata t-wata left a comment

Choose a reason for hiding this comment

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

It seems to me that the explanation is incorrect.
How about a sentence like the following?

Comment on lines 150 to 151
* `config_drive` - (Optional) true is specified, can set to write metadata
to the ephemeral drive. Defaults to false.
Copy link

Choose a reason for hiding this comment

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

Suggested change
* `config_drive` - (Optional) true is specified, can set to write metadata
to the ephemeral drive. Defaults to false.
* `config_drive` - (Optional) If true is specified, a configuration drive will be mounted
to enable metadata injection in the server. Defaults to false.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you. I fixed it like this.

Copy link

@t-wata t-wata left a comment

Choose a reason for hiding this comment

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

Thanks. LGTM 👍

@shimisho shimisho merged commit e179d0f into master May 29, 2020
@shimisho shimisho deleted the update_website_docs branch May 29, 2020 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants