Doc fixes. #821
Merged
Doc fixes. #821
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: geeknoid 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 |
frankbu
reviewed
Feb 26, 2019
networking/v1alpha3/sidecar.proto
Outdated
| // VirtualServices from remote namespaces corresponding to the specified | ||
| // hosts will be imported. The service in a namespace can be a service in | ||
| // the service registry (e.g., a kubernetes or cloud foundry service) or | ||
| // the service registry (e.g., aKubernetes or cloud foundry service) or |
There was a problem hiding this comment.
Suggested change
| // the service registry (e.g., aKubernetes or cloud foundry service) or | |
| // the service registry (e.g., a Kubernetes or cloud foundry service) or |
frankbu
reviewed
Feb 26, 2019
| // The following Kubernetes example routes all traffic by default to pods | ||
| // of the reviews service with label "version: v1" (i.e., subset v1), and | ||
| // some to subset v2, in a kubernetes environment. | ||
| // some to subset v2, in aKubernetes environment. |
There was a problem hiding this comment.
Suggested change
| // some to subset v2, in aKubernetes environment. | |
| // some to subset v2, in a Kubernetes environment. |
frankbu
reviewed
Feb 26, 2019
policy/v1beta1/cfg.proto
Outdated
| // | ||
| // In the following example we define a `metrics` handler for the `prometheus` adapter. | ||
| // The example is in the form of a kubernetes resource: | ||
| // The example is in the form of aKubernetes resource: |
There was a problem hiding this comment.
Suggested change
| // The example is in the form of aKubernetes resource: | |
| // The example is in the form of a Kubernetes resource: |
frankbu
reviewed
Feb 26, 2019
policy/v1beta1/type.proto
Outdated
| import "google/protobuf/timestamp.proto"; | ||
|
|
||
| // An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any | ||
| // An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluatee to any |
There was a problem hiding this comment.
Suggested change
| // An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluatee to any | |
| // An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluate to any |
frankbu
reviewed
Feb 26, 2019
policy/v1beta1/type.proto
Outdated
| } | ||
|
|
||
| // An instance field of type IPAddress denotes that the expression for the field must evalaute to | ||
| // An instance field of type IPAddress denotes that the expression for the field must evaluatee to |
There was a problem hiding this comment.
Suggested change
| // An instance field of type IPAddress denotes that the expression for the field must evaluatee to | |
| // An instance field of type IPAddress denotes that the expression for the field must evaluate to |
There was a problem hiding this comment.
Whole bunch more evaluatee
geeknoid
pushed a commit
that referenced
this pull request
Mar 9, 2019
* Doc fixes. * Add high-level overview and diagrams for MCP (#805) * document MCP * add additional note on NACK behavior * add a note about ignoring stale nonces * Add envoy metrics service configuration to ProxyConfig (#803) * Add envoy metrics service configuration to ProxyConfig Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API. * Update proto.lock * Reorder metrics_service_address just after statsd_udp_address * Update comment in the authN API to match with 1.1 behavior (#808) * Rename metrics_service_address to clarify that it is for Envoy's API (#809) Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API. * Generate separate HTML page per proto under networking (#811) * Generate separate pages for each networking proto Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * tweaks Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Fix interdoc references * separate doc and go gen * change dash to underscore * fix * more fixes * makefile fix Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * remove bad target * Revert "change dash to underscore" This reverts commit 7fbced6. * final update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Revert "Generate separate HTML page per proto under networking (#811)" This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io * Update to latest tools. * Revert "Update to latest tools." This reverts commit 231fadc which I accidentally pushed to the wrong place. * fix mcp update error diagram (#810) * update istio/tools (#815) * Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818) * Minor updates for building docker images. (#817) * Add spell checking for docs. (#819) * Add a bunch of words to the custom dictionary. * Document exportTo restrictions (#820) * Doc fixes. (#821) * Proxy config: Add tls_certs_to_watch field (#824) * Proxy config: Add tls_certs_to_watch field * Address PR comment * Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825) This reverts commit e613e35. * Update gateway and sidecar hosts doc (#826) * Update gateway and sidecar hosts doc * regen * review comments * Update API docs (service entry, gateway, sidecar) (#831) * Update sidecar and gateway docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * gen docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update service entry Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * updates Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * add configurable dns refresh rate to mesh for strict dns cluster, (#832) * add configurable dns refresh rate to mesh for strict dns cluster, issue #12181 * add lock file * Post-merge generation
istio-testing
pushed a commit
that referenced
this pull request
Mar 21, 2019
* Doc fixes. * Add high-level overview and diagrams for MCP (#805) * document MCP * add additional note on NACK behavior * add a note about ignoring stale nonces * Add envoy metrics service configuration to ProxyConfig (#803) * Add envoy metrics service configuration to ProxyConfig Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API. * Update proto.lock * Reorder metrics_service_address just after statsd_udp_address * Update comment in the authN API to match with 1.1 behavior (#808) * Rename metrics_service_address to clarify that it is for Envoy's API (#809) Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API. * Generate separate HTML page per proto under networking (#811) * Generate separate pages for each networking proto Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * tweaks Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Fix interdoc references * separate doc and go gen * change dash to underscore * fix * more fixes * makefile fix Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * remove bad target * Revert "change dash to underscore" This reverts commit 7fbced6. * final update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Revert "Generate separate HTML page per proto under networking (#811)" This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io * Update to latest tools. * Revert "Update to latest tools." This reverts commit 231fadc which I accidentally pushed to the wrong place. * fix mcp update error diagram (#810) * update istio/tools (#815) * Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818) * Minor updates for building docker images. (#817) * Add spell checking for docs. (#819) * Add a bunch of words to the custom dictionary. * Document exportTo restrictions (#820) * Doc fixes. (#821) * Proxy config: Add tls_certs_to_watch field (#824) * Proxy config: Add tls_certs_to_watch field * Address PR comment * Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825) This reverts commit e613e35. * Update gateway and sidecar hosts doc (#826) * Update gateway and sidecar hosts doc * regen * review comments * Update API docs (service entry, gateway, sidecar) (#831) * Update sidecar and gateway docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * gen docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update service entry Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * updates Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * add configurable dns refresh rate to mesh for strict dns cluster, (#832) * add configurable dns refresh rate to mesh for strict dns cluster, issue #12181 * add lock file * Hosts are not ignored in ServiceEntry for HTTPs (#833) * Hosts are not ignored in ServiceEntry for HTTPs * Clarify * Reword * Generate protos * Address code review comments * Fix typo * generate * make mixer config marshal deterministic (#846) Signed-off-by: Kuat Yessenov <kuat@google.com> * Fix some doc errors. (#854) This started out to just fix a bad link to unblock work on istio.io, but I ended up fixing a bunch of typos/incorrect format throughout. * Fix two more broken links. (#856) * Fix CRD examples for release-1.1 (#859) * fix MeshNetworks demo (#841) * fix MeshNetworks demo * generate * update * last minute doc fixes (#865) Signed-off-by: Shriram Rajagopalan <rshriram@gmail.com> * Clarify comment for server_name field in Mixer oop auth config (#800) * add mixerclient config to istio.io reference docs (#827) * Envoyfilter docs fix (#867) * Tweaks to get the mixer client config docs to be published. (#868) * Change where the Mixer client docs are published.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.