Refactor docs #156
Refactor docs #156
Conversation
There was a problem hiding this comment.
I love where this is headed. A bunch of nitpicky comments.
One other thing -- should we mention somewhere that one bit of "special sauce" in here is the script to release the license on container kill and people should be sure to keep that bit if they're editing the files for their own use?
server-pro/README.md
Outdated
| | `RSP_LICENSE` | License key for RStudio Server Pro, format should be: `XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX` | None | | ||
| | `RSP_LICENSE_SERVER` | Floating license server, format should be: `my.url.com:port` | None | | ||
| | `RSP_LAUNCHER` | Whether or not to use launcher locally / start the launcher process | true | | ||
| | `RSP_LAUNCHER_TIMEOUT` | The timeout, in seconds, to wait for launcher to startup before proceeding | 10 | |
There was a problem hiding this comment.
This is upon container start? If so...
| | `RSP_LAUNCHER_TIMEOUT` | The timeout, in seconds, to wait for launcher to startup before proceeding | 10 | | |
| | `RSP_LAUNCHER_TIMEOUT` | Number of seconds to pause container startup for the launcher process to start | 10 | |
There was a problem hiding this comment.
Not sure I understood quite right what this is...
There was a problem hiding this comment.
Yeah, it's not quite "pause container startup." This is basically how long to wait for the launcher to start. Usually it is very quick. If it does not succeed in this amount of time, then the container startup will fail / error.
There was a problem hiding this comment.
Tried to add a bit more explanation
There was a problem hiding this comment.
Aha -- maybe it'd be clearer to say the timeout is until an error...because it's not a "wait to proceed", it's a "wait to fail", right?
What about "The time, in seconds, the container waits for the launcher process to start before throwing an error"?
There was a problem hiding this comment.
So it's not necessarily a "wait to error." It's very hard / tricky to tell if launcher failed (i.e. it could just sit there doing nothing forever). It is literally "wait X seconds, if you don't get a listening service by then, presume failure"
There was a problem hiding this comment.
"The time, in seconds, to wait for a listening launcher process before throwing an error"?
There was a problem hiding this comment.
This really isn't a big deal 😆. I'm sure it's fine as is. I'm just persnickety about writing.
Co-authored-by: Alex Gold <alex.gold@rstudio.com>
Co-authored-by: Alex Gold <alex.gold@rstudio.com>
| #### Users | ||
|
|
||
| By default, the container will create a test user, which you can control or disable with the environment | ||
| variables: `RSP_TESTUSER`, `RSP_TESTUSER_PASSWD`, `RSP_TESTUSER_UID`. |
There was a problem hiding this comment.
I assume renaming from RSP will be a part of the workbench conversion?
There was a problem hiding this comment.
Yeah, that's a good call... breaking, unfortunately, but we haven't published the workbench images widely yet 🤷♂️ (or documented publicly)
|
|
||
| **WARNING**: Floating Licenses should not be used within docker containers in a production context, since the docker | ||
| container failing could require manual intervention to fix (see the app below). We provide these images only for | ||
| development and testing. |
There was a problem hiding this comment.
@akgold Does this warning not suffice? Not clear enough? There is another one down below
There was a problem hiding this comment.
I think it's ok. I'd probably vote to go even a little stronger. I struggle to see a situation where customers should use these at all if they're not in direct conversation with us.
Like...I think our preferred recommendation would be to set up the license server, then start playing with the rest of Team.
There was a problem hiding this comment.
For sure. I agree 😄 I'll make it stronger
Co-authored-by: Alex Gold <alex.gold@rstudio.com>
Co-authored-by: Alex Gold <alex.gold@rstudio.com>
Split READMEs into separate per-directory READMEs
Create table of contents for the main README.md