Update doc to include getting an API Key from the dashboard #1038
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
|  | ||
|
|
||
| - Click on `Create Stream` and your dashboard should look like: |
There was a problem hiding this comment.
This step seems copied from somewhere else. Also, if you change this to just "create", might as well remove the instruction on the step above?
There was a problem hiding this comment.
fixed changes and rewording
|
|
||
| - Click on `Create Stream` and your dashboard should look like: | ||
|
|
||
|  |
There was a problem hiding this comment.
This files should probably have a more specific name. We have plenty of API guides so it can get confusing if we have a bunch of these with no reference to which guide they are used from.
I would go with sth like /img/docs/api-key-1/2/3/4.png, with the same name as the .mdx
There was a problem hiding this comment.
fixed the folder structure for screen shot
| Login to the Livepeer.com Dashboard, and navigate to | ||
| [the API keys page within the Developers tab](https://livepeer.com/dashboard/developers/api-keys). | ||
| On this page, you can manage your API keys including creating or deleting them | ||
| and monitoring their usage. |
There was a problem hiding this comment.
Shouldn't this be inside the "how to get an API key..." section?
|
|
||
| - A popup should show up. Enter the name for your API key and then Click `Create`. | ||
|
|
||
|  |
There was a problem hiding this comment.
This screenshot is outdated since it doesn't have the CORS checkbox. This how-to is also not mentioning anything about CORS, which I think it must. Would you mind adding some information about it here? Maybe a screenshot about it as well, can copy the ones from the CORS section below (and remove from it, if it makes sense).
There was a problem hiding this comment.
@codentell can you update the screenshot and resubmit the PR?
There was a problem hiding this comment.
@pglowacky i can updated the screenshot
| make sure to persist the API key safely. If you ever forget an API key you'll | ||
| always be able to delete it and create a new one anyway. | ||
|
|
||
| #### 🎉 Congrats! You have created an API key with Livepeer using the dashboard 🎉 | ||
|
|
||
| ## Usage |
There was a problem hiding this comment.
Hmmm, mixed feelings about mixing different kinds of documentations on the same file here. Previously what we had was something in between a "tutorial" and an "explanation" (doc system), which are focused more for users learning about API keys. We did have short instructions on how to create an API key but just linked to the dashboard and assumed it was intuitive (did you get reports of users having problems with that?).
This new section is very much a "how-to" guide tho (literally even the title). I think it mixes the crowds in this document and can make it an unsatisfying experience both for people looking for learning, getting lost in the middle of a step by step how-to, as well as for those just looking to get started with a step by step guide since there will be a lot of information they don't really want here.
So I think that we should break those up. The new section you are creating is actually the one that looks more like a "how to" guide, while all the explanations could go into the API reference doc instead (which currently is really small, needs improvement anyway so this makes sense). Then here we can focus more on a simple how-to guide, and link to the API reference doc in any case we mention something that is a little more complex to explain inline (i.e. CORS 😆). WDYT?
There was a problem hiding this comment.
@victorges Totally agree with this -- we need to do a better job across all of our documentation of separating out references vs. tutorials. We're going to work on overhauling all the docs this quarter. For now, I think including the tutorial here is okay -- we currently don't have a place to put tutorials and how-tos anywhere.
@codentell Can you remove the "Congrats" line and resubmit the PR, forgot to remove before approving 🙃
There was a problem hiding this comment.
We already have a separation of guides vs reference, which I thought could be the distinction for higher-level/how-to things vs more technical details. If we wanna get this through ASAP for some reason I guess it's ok as is then. Would just try to keep them as separate as possible in the document. Right now we are doing explanation-howto-explanation which seems like a bad reading experience. Maybe move the howto to the very end or the very beginning of the doc instead (maybe beginning, since the name of this doc is "get an api key")
What does this pull request do? Explain your changes. (required)
Update “Get an API Key” /doc to include getting an API Key from the dashboard with
screenshots and step by step guide
Specific updates (required)
-
Does this pull request close any open issues?
Screenshots (optional):
Checklist: