Generate separate HTML page per proto under networking #811

rshriram · 2019-02-22T17:13:03Z

This makes the networking reference docs a bit more readable instead
of one large compendium of all protos.

Signed-off-by: Shriram Rajagopalan shriramr@vmware.com

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

rshriram · 2019-02-22T17:15:04Z

an example of how the docs are rendered: https://deploy-preview-3358--preliminary-istio.netlify.com/docs/reference/config/networking/

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

frankbu · 2019-02-22T17:23:49Z

This is great. Makes "the docs a bit more readable ..." is an understatement. They are WAY MORE readable.

You need to fix the broken inter-doc and external links, though, or you won't be able to push a PR istio.io

googlebot · 2019-02-22T18:11:32Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

ℹ️ Googlers: Go here for more info.

andraxylia · 2019-02-22T19:35:59Z

/lgtm
/approve

istio-testing · 2019-02-22T19:36:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andraxylia, rshriram

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:

~~OWNERS~~ [andraxylia,rshriram]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…parate_html

…ate_html

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

geeknoid · 2019-02-22T20:46:40Z

You need to add $aliases directives to point old links to new places.

rshriram · 2019-02-22T20:52:18Z

we dont have any links to these fields directly. I added the alias in istio.io to redirect to the index page for this section..

This reverts commit 7fbced6.

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io

geeknoid · 2019-02-23T19:53:15Z

I just reverted this change since it's breaking the ability to generate working reference docs in istio.io. We need to work out linking issues before redoing this change.

geeknoid · 2019-02-24T06:14:27Z

#812 updates the tools. Once that PR is merged, you can retry this PR and hopefully this will fix some of the link issues with the per-file mode.

istio#811)"" This reverts commit 11e69f5.

#811)"" (#818)

* 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

* 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.

Shriram Rajagopalan added 2 commits February 22, 2019 11:11

Generate separate pages for each networking proto

5424864

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

update

dce652d

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

istio-testing requested review from andraxylia and geeknoid February 22, 2019 17:13

googlebot added the cla: yes Set by the Google CLA bot to indicate the author of a PR has signed the Google CLA. label Feb 22, 2019

istio-testing added the approved label Feb 22, 2019

tweaks

38010d8

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

Fix interdoc references

d00bc8b

googlebot added cla: no Set by the Google CLA bot to indicate the author of a PR has not signed the Google CLA. and removed cla: yes Set by the Google CLA bot to indicate the author of a PR has signed the Google CLA. labels Feb 22, 2019

frankbu added 2 commits February 22, 2019 13:32

separate doc and go gen

96dddba

change dash to underscore

7fbced6

andraxylia approved these changes Feb 22, 2019

View reviewed changes

istio-testing assigned andraxylia Feb 22, 2019

istio-testing added the lgtm label Feb 22, 2019

Shriram Rajagopalan added 5 commits February 22, 2019 15:35

fix

f94a737

Merge branch 'separate_html' of ssh://github.com/rshriram/api into se…

7c25acd

…parate_html

Merge branch 'release-1.1' of https://github.com/istio/api into separ…

df92345

…ate_html

more fixes

3e9020b

makefile fix

8a4c114

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

Shriram Rajagopalan added 3 commits February 22, 2019 15:53

remove bad target

35ae03d

Revert "change dash to underscore"

91f7872

This reverts commit 7fbced6.

final update

5b71237

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

rshriram merged commit 5f14ead into istio:release-1.1 Feb 22, 2019

geeknoid pushed a commit that referenced this pull request Feb 23, 2019

Revert "Generate separate HTML page per proto under networking (#811)"

11e69f5

This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io

rshriram pushed a commit to rshriram/api that referenced this pull request Feb 25, 2019

Revert "Revert "Generate separate HTML page per proto under networking (

42c0550

istio#811)"" This reverts commit 11e69f5.

rshriram mentioned this pull request Feb 25, 2019

repeat: Generate separate HTML page per proto under networking #818

Merged

geeknoid pushed a commit that referenced this pull request Feb 26, 2019

Revert "Revert "Generate separate HTML page per proto under networking (

18f2d9a

#811)"" (#818)

esimons mentioned this pull request Mar 18, 2019

Fix sample code in HTML reference docs #862

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Generate separate HTML page per proto under networking #811

Generate separate HTML page per proto under networking #811

Uh oh!

rshriram commented Feb 22, 2019

Uh oh!

rshriram commented Feb 22, 2019

Uh oh!

frankbu commented Feb 22, 2019

Uh oh!

googlebot commented Feb 22, 2019

Uh oh!

andraxylia commented Feb 22, 2019

Uh oh!

istio-testing commented Feb 22, 2019

Uh oh!

geeknoid commented Feb 22, 2019

Uh oh!

rshriram commented Feb 22, 2019

Uh oh!

geeknoid commented Feb 23, 2019

Uh oh!

geeknoid commented Feb 24, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Generate separate HTML page per proto under networking #811

Generate separate HTML page per proto under networking #811

Uh oh!

Conversation

rshriram commented Feb 22, 2019

Uh oh!

rshriram commented Feb 22, 2019

Uh oh!

frankbu commented Feb 22, 2019

Uh oh!

googlebot commented Feb 22, 2019

Uh oh!

andraxylia commented Feb 22, 2019

Uh oh!

istio-testing commented Feb 22, 2019

Uh oh!

geeknoid commented Feb 22, 2019

Uh oh!

rshriram commented Feb 22, 2019

Uh oh!

geeknoid commented Feb 23, 2019

Uh oh!

geeknoid commented Feb 24, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants