Edited and restructured server-api file
#4106
Conversation
minrk
added
documentation
outreachy-dec22
docs/source/reference/server-api.md
Outdated
| (attempting to access it may not work) | ||
| because it isn't finished spawning yet. | ||
| We'll get more into that below in [waiting for a server][]. | ||
| Note that `ready` is assigned `false` and `pending` is assigned `spawn`, meaning that the server is not ready and attempting to access it may not work as it is still in the process of spawning. |
There was a problem hiding this comment.
I'm not sure assigned is helpful here. I would still say ready is false. But if you do find we need different language, I would probably pick something like 'has the value'. But in short, I think is is clear and concise and standard language for a field having a value.
Can you speak more to removing the link? It seems useful to keep it here that we're going to get more into that later.
There was a problem hiding this comment.
I have removed assigned as suggested. I have also returned the link as your explanation makes sense. I removed it as I figured the reader will get to the section either way, so it did not add any value having the information.
docs/source/reference/server-api.md
Outdated
|
|
||
| [waiting for a server]: waiting | ||
|
|
||
| (starting)= | ||
|
|
||
| ## Starting servers | ||
|
|
||
| To start a server, make the request | ||
| To start a server, make the following API request: |
There was a problem hiding this comment.
| To start a server, make the following API request: | |
| To start a server, make the API request: |
There was a problem hiding this comment.
I have used "this" rather than "the"
Thanks @minrk . I will update the file accordingly. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Hi @minrk. |
|
Wonderful, thank you! |
|
Thank you too @minrk for your review and guidance. I have truly learnt a lot from this experience. |
I have edited and restructured some parts of the page to make it tighter and as per the Diataxis model.
Managing servers using the JupyterHub APIand notStarting servers using the JupyterHub API.Startinga server is only one of the steps covered in the article and it does not, therefore, give a comprehensive picture of what the article is about. However, I have not changed the title as doing so might break something else somewhere.Progress APIand notprogress API, which breaks the sentence case styling of (sub)headings. However, I feel using a proper noun forProgressmakes more sense given the context. I am open to corrections on this though.