diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 91f96fb9..3534d450 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -23,8 +23,10 @@ Resource Types:

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: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

+by multiple definitions. + +For more information on Knative Autoscalers and Pluggability, +see the Knative Pluggability presentation.

@@ -707,14 +709,18 @@ Resource Types:
  • Service
    • +

    For an overview of the different Resource Types in Knative Serving and how they interact with one another, see this explanation of Resource Types

    +

    Configuration

    +

    Configuration represents the “floating HEAD” of a linear history of Revisions. Users create new Revisions by updating the Configuration’s spec. The “latest created” revision’s name is available under status, as is the “latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

    + +For more information on how Configuration interacts with other Resource Types, see the "Configuration" sub-heading in the Resource Types Overview.

    @@ -808,7 +814,8 @@ ConfigurationStatus

    Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration.

    -

    See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

    + +

    For more information on how Revision interacts with other Resource Types, see the "Revision" sub-heading in the Resource Types Overview.

    @@ -934,7 +941,8 @@ Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for “latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

    + +For more information on how Route interacts with other Resource Types, see the "Route" sub-heading in the Resource Types Overview.

    @@ -1037,7 +1045,8 @@ underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets), and its usage is optional but recommended.

    The Service’s controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.

    -

    See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

    + +

    For more information on how Service interacts with other Resource Types, see the "Service" sub-heading in the Resource Types Overview.

    @@ -1452,7 +1461,7 @@ If multiple containers specified then DeprecatedImageDigest holds the digest for serving container. DEPRECATED: Use ContainerStatuses instead. TODO(savitaashture) Remove deprecatedImageDigest. -ref https://kubernetes.io/docs/reference/using-api/deprecation-policy for deprecation.

    +(see Kubernetes Deprecation Policy) for deprecation.

    @@ -1471,7 +1480,7 @@ to their respective digests and their container name. The digests are resolved during the creation of Revision. ContainerStatuses holds the container name and image digests for both serving and non serving containers. -ref: http://bit.ly/image-digests

    +See the Proposal for multiple containers in a revision for some context on this field.

    @@ -1484,7 +1493,7 @@ ref: http://bit.ly/image-digests

    RevisionTemplateSpec describes the data a revision should have when created from a template. -Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190

    +Based on the PodTemplateSpec in Kubernetes

    @@ -2038,9 +2047,7 @@ Kubernetes meta/v1.ObjectMeta @@ -2055,7 +2062,7 @@ DomainMappingSpec
    (Optional)

    Standard object’s metadata. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

    -Refer to the Kubernetes API documentation for the fields of the -metadata field. +Refer to the Kubernetes API documentation for the fields of the metadata field.
    (Optional)

    Spec is the desired state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    +Refer to the Kubernetes API documentation for more info on the DomainMappingSpec field.

    @@ -2086,7 +2093,7 @@ DomainMappingStatus
    (Optional)

    Status is the current state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    +Refer to the Kubernetes API documentation for more info on the DomainMappingStatus field.