Update docs #5595
Update docs #5595
Conversation
holmanb
force-pushed
the
holmanb/single-process-docs
branch
from
577fa19
to
6f6861f
Compare
|
|
||
| - :command:`blame` | ||
| - :command:`show` | ||
| - :command:`dump` | ||
| - :command:`boot` | ||
|
|
||
| The analyze subcommand works by parsing the cloud-init log file for timestamps |
There was a problem hiding this comment.
This subcommand fails to capture interpreter startup time and library load time because of this fact, so at least advertise how it works so that users can draw their own conclusions.
| @@ -65,7 +65,6 @@ Using ``instance-data`` | |||
|
|
|||
| ``instance-data`` can be used in: | |||
|
|
|||
| * :ref:`User data scripts<user_data_script>`. | |||
There was a problem hiding this comment.
This was redundant, since user data scripts are documented on the user data formats page.
| @@ -2,18 +2,12 @@ Kernel command line | |||
| ******************* | |||
|
|
|||
| Providing configuration data via the kernel command line is somewhat of a last | |||
| resort, since this method only supports | |||
| :ref:`cloud config<user_data_formats-cloud_config>` starting with | |||
There was a problem hiding this comment.
This piece of information doesn't apply to datasource discovery override, and is already mentioned in the section below that it is relevant to. Drop it.
Thanks for the review @a-dubs. I just added some more content and fixed the issue you pointed out! |
| @@ -65,7 +65,6 @@ Using ``instance-data`` | |||
|
|
|||
| ``instance-data`` can be used in: | |||
|
|
|||
| * :ref:`User data scripts<user_data_script>`. | |||
There was a problem hiding this comment.
Why the removal? It's a valid usage
There was a problem hiding this comment.
This was redundant, since user data scripts are documented on the user data formats page.
There was a problem hiding this comment.
Gotcha. As-is, it's a little weird though. The text says Cloud-config but links to the user data page (not your doing). We could update the text of the link to say 'user data' rather than 'cloud-config', you can only use instance data in cloud-config and user scripts, so I'm not sure we should be saying it can be used with user data when there are caveats to that.
I think we should either specify cloud-config and user data scripts independently and be ok with the redundancy, or we should link to the jinja format and say any user data format supported by jinja.
There was a problem hiding this comment.
@TheRealFalcon good point. I just pushed an update, let me know what you think.
|
@TheRealFalcon thanks for your review. I think that I've addressed all of your comments. |
|
@TheRealFalcon ready for re-review, thanks! |
holmanb
force-pushed
the
holmanb/single-process-docs
branch
from
710c05e
to
1c42f46
Compare
Also shift the format page higher in the explanation page list, since this is a high traffic page.
holmanb
force-pushed
the
holmanb/single-process-docs
branch
from
1c42f46
to
cadc6a9
Compare
|
I just rebased the fixup commits and updated commit messages with PR number. |
Also shift the format page higher in the explanation page list, since this is a high traffic page.
This reverts commit bd6cd1f.
This reverts commit bd6cd1f.
Additional Context
Documents #5489, sprinkles in some more links to connect related pages, and moves the first boot determination docs into a dedicated page.
Merge type