Creating a new section for installing mirrord in docs#94
Creating a new section for installing mirrord in docs#94danielbaker wants to merge 5 commits intomainfrom
Conversation
|
Maybe we can merge the Troubleshooting section into a single page instead of a dropdown with two pages? Because the first page in that dropdown ("Response Header Injection") doesn't have a lot of content. It could just go under "Common Issues" only. WDYT? |
|
|
||
| # CLI | ||
|
|
||
| The mirrord CLI is the core tool for running mirrord from the command line. It can be used standalone, or is automatically managed by the IDE extensions. |
There was a problem hiding this comment.
Do you still need mirrord CLI installed if you're only using the extension?
Because if not then "is automatically managed by the IDE extensions" is incorrect.
There was a problem hiding this comment.
nope, its either this or that
There was a problem hiding this comment.
auto manage sounds for me ok but I agree it can be phrased clearer
There was a problem hiding this comment.
I think it makes sense to just remove that sentence all together, its not adding anything
| mirrord exec --target pod/app-pod-01 python main.py | ||
| ``` | ||
|
|
||
| Or, if you'd rather run a local container than a native process, run: |
There was a problem hiding this comment.
I'm not sure I understand this. I've never used this command and it wasn't clear from this line what or why I'd use this.
There was a problem hiding this comment.
just sometimes when you have many dependencies it might be simpler to run a container instead of a local process, we do support it
There was a problem hiding this comment.
If it's not commonly used I wouldn't mention it in the main CLI page like this
There was a problem hiding this comment.
I'll remove this
|
|
||
| ## Interactive Setup | ||
|
|
||
| You can use `mirrord wizard` to generate a `mirrord.json` configuration file interactively. This walks you through common use cases to help you create a configuration tailored to your needs. [Click here](/docs/overview/onboarding-wizard.md) for more information. |
There was a problem hiding this comment.
Add a line introducing mirrord.json and telling that that's where configuration lives.
There was a problem hiding this comment.
There is a section just below that introduces it, im moving it up
| mirrord --version | ||
| ``` | ||
|
|
||
| To check connectivity to your cluster and the mirrord Operator (if using mirrord for Teams or Enterprise): |
There was a problem hiding this comment.
link to mirrord for Teams
the 'response header inject' is not an issue, so it doesnt make sense to me to add it under that section.. its a small feature we provide for trubleshooting. |
There was a problem hiding this comment.
This should be under Using mirrord, not Installing mirrord (and with a more descriptive title)
There was a problem hiding this comment.
I've moved it and changed the title to "Working with Local Containers". Open to further suggestions on the title
| @@ -0,0 +1,28 @@ | |||
| --- | |||
| title: Installing mirrord | |||
There was a problem hiding this comment.
Isn't this section duplicative with Quick Start? Why do we need both?
There was a problem hiding this comment.
There is duplicated content, but its relevant to both the quickstart and this section too. If someone is looking for more complete instructions than what you would typically find in a quick start, I would expect to find it here.
danielbaker
force-pushed
the
setup-docs-restrcuture
branch
from
30766f5 to
11d22eb
Compare
|
I have pushed a new update addressing the comments |
4 participants
Move the install mirrord pages into their own menu structure