Add documentation for Create Porter's Configuration file under Task #2045
Conversation
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
VinozzZ
requested review from
carolynvs,
jeremyrickard and
vdice
as code owners
| - operators/configuration/ | ||
| --- | ||
|
|
||
| Porter's default behavior, such as log level, default plugins, etc., can be modified through its config file. |
There was a problem hiding this comment.
nit: This simplifies the punctuation in the sentence a bit. It's a good idea for us to avoid Latin abbreviations such as "e.g.", "i.e.", and "etc". Using the equivalent English words makes the content more accessible to people who speak other languages.
| Porter's default behavior, such as log level, default plugins, etc., can be modified through its config file. | |
| Porter's default behavior, such as the log level and default plugins, can be modified through its config file. |
There was a problem hiding this comment.
Marking as unresolved since the change wasn't accepted or replied to.
VinozzZ
force-pushed
the
task-create-config-file
branch
from
375fe6d
to
24e3f9f
Compare
|
@VinozzZ I'm seeing comments marked as resolved but no corresponding change in the pushed commits. Can you please check if you have uncommitted changes or some commits that haven't been pushed yet? |
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
VinozzZ
force-pushed
the
task-create-config-file
branch
from
24e3f9f
to
b7fddbb
Compare
Oops, you are right. I forgot to push up some changes. Should be fixed now |
There was a problem hiding this comment.
Your new page isn't showing up in the site navigation. If you add a link to this file, https://github.com/getporter/porter/blob/release/v1/docs/config.toml then it will show up.
Don't forget that you can preview the docs locally too, which can be quicker than relying on the netlify previews: https://github.com/getporter/porter/blob/main/CONTRIBUTING.md#preview-documentation
|
|
||
| First check if you have PORTER_HOME set on your machine: | ||
| ```console | ||
| $ echo $PORTER_HOME |
There was a problem hiding this comment.
The porter documentation should always show commands that work in any shell (like porter commands) or we need to provide an example for each shell (Bash + Powershell).
I think the docs here could be redone pretty easily to avoid "bash-isms" by not setting the PORTER_HOME env var (which I honestly don't recommend anyone should set anyway unless they really need to change the home directory which we aren't doing here). Then you can reference were to locate the config file with "in your PORTER_HOME directory, which defaults to ~/.porter" and leave it up to them to find the directory.
There was a problem hiding this comment.
The most recent changes don't quite address what was called out here. I'll add some specific comments on the docs to give examples of how to achieve what we need.
|
|
||
| First check if you have PORTER_HOME set on your machine: | ||
| ```console | ||
| $ echo $PORTER_HOME |
There was a problem hiding this comment.
The most recent changes don't quite address what was called out here. I'll add some specific comments on the docs to give examples of how to achieve what we need.
| - operators/configuration/ | ||
| --- | ||
|
|
||
| Porter's default behavior, such as log level, default plugins, etc., can be modified through its config file. |
There was a problem hiding this comment.
Marking as unresolved since the change wasn't accepted or replied to.
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
VinozzZ
force-pushed
the
task-create-config-file
branch
from
fe6e380
to
d540387
Compare
What does this change
What issue does it fix
Work for #1027
Notes for the reviewer
Put any questions or notes for the reviewer here.
Checklist
Reviewer Checklist