Knative API docs for v0.20.0 #3141
Conversation
| @@ -24,7 +24,7 @@ Resource Types: | |||
| <p>PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative | |||
| components instantiate autoscalers. This definition is an abstraction that may be backed | |||
| by multiple definitions. For more information, see the Knative Pluggability presentation: | |||
| <a href="https://docs.google.com/presentation/d/e/2PACX-1vQ4kT92QNXvBF9dJzVfF_zqUROoG1wZXf-ATMKi8d43htvt3Osq6k-1YUWAO9M27gZ8C-cGBQA8-bwJ/pub">https://docs.google.com/presentation/d/e/2PACX-1vQ4kT92QNXvBF9dJzVfF_zqUROoG1wZXf-ATMKi8d43htvt3Osq6k-1YUWAO9M27gZ8C-cGBQA8-bwJ/pub</a></p> | |||
| <a href="https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit">https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit</a></p> | |||
There was a problem hiding this comment.
I'd change this to something like:
For more information, see the < a href="https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit" >Knative pluggability presentation < /a> < /p>
(sorry about the spaces, had to add them so it showed this in the comments and not just the link 🙃 )
There was a problem hiding this comment.
Similar thing here too: https://5ffe5166b7462545d9c8fc4d--knative.netlify.app/docs/reference/api/serving-api/#serving.knative.dev/v1.Configuration
I'd try to show descriptive names for all the links rather than:
"See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration"
There was a problem hiding this comment.
I think most sections of this preview have similar issues
There was a problem hiding this comment.
@abrennan89 all these strings are located in the source code, we only just build and publish an HTML version. I do agree that these are improvements but the edits should be made in the source rather than here in the output. Let me know if thats something you want to dive into. Alternatively, open a bug for the Serving team to get this fixed for the next release?
There was a problem hiding this comment.
Makes sense, opened an issue to track it for the next release 🙂
| </td> | ||
| </tr><tr><td><p>"pending"</p></td> | ||
| <td><p>RoutingStatePending is a state after a revision is created, but before | ||
| its routing state has been determined. It is treated like active for the purposes |
There was a problem hiding this comment.
| its routing state has been determined. It is treated like active for the purposes | |
| its routing state has been determined. It is treated as active for the purposes |
There was a problem hiding this comment.
Maybe sounds better? Was just making suggestions after reading through it.
|
/lgtm @RichieEscarez I'll let you remove the hold when you want to merge just in case 🙂 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, RichieEscarez The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thank you both! |
|
/retest |
* update API docs for v0.20.0 * remove whitespace -> happy linter
New v0.20.0 API docs.
Command:
Also investigated and resolved new API build errors (due to constant types) (details)
Netlify preview: https://5ffe5166b7462545d9c8fc4d--knative.netlify.app/docs/reference/api/