Skip to content

doc: update obsolete ref to api/XDS_PROTOCOL.md#7002

Merged
mattklein123 merged 4 commits intoenvoyproxy:masterfrom
lambdai:docfix
May 22, 2019
Merged

doc: update obsolete ref to api/XDS_PROTOCOL.md#7002
mattklein123 merged 4 commits intoenvoyproxy:masterfrom
lambdai:docfix

Conversation

@lambdai
Copy link
Contributor

@lambdai lambdai commented May 19, 2019

Description:

replace XDS_PROTOCOL.md by :ref: xds_protocol series

Signed-off-by: Yuchen Dai silentdai@gmail.com

Risk Level: None
Testing: None
Docs Changes: fix only
Release Notes: None

@mattklein123 mattklein123 self-assigned this May 19, 2019
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this. Please switch these all to proper :ref: links. The primary reason we moved this file was to get better linking.

/wait

fixed by
```
grep XDS_PROTOCOL.md -rnl api include docs source | \
xargs sed -i 's/XDS_PROTOCOL.md/xds_protocol.rst/g'
```
Signed-off-by: Yuchen Dai <silentdai@gmail.com>
@lambdai
Copy link
Contributor Author

lambdai commented May 20, 2019

Will update.
Question: What is the benefit of the ref? Is it because of relative path? Or is ref validated?

@mattklein123
Copy link
Member

:ref: is validated.

Signed-off-by: Yuchen Dai <silentdai@gmail.com>
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you! One missing switch.

/wait

// <envoy_api_msg_route.VirtualHost.domains>` field. The *resource_names_unsubscribe* field contains
// a list of virtual host names that have been `unsubscribed
// <https://github.com/envoyproxy/envoy/blob/master/api/XDS_PROTOCOL.md#unsubscribing-from-resources>`_
// <https://github.com/envoyproxy/envoy/blob/master/api/xds_protocol.rst#unsubscribing-from-resources>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be a ref link

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too excited about the 0 warning and didn't realize this one does't give warning. Fixed now

Signed-off-by: Yuchen Dai <silentdai@gmail.com>
mattklein123
mattklein123 previously approved these changes May 21, 2019
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you this is awesome.

@mattklein123
Copy link
Member

Oops sorry looks like this needs a format fix.

/wait

@lambdai
Copy link
Contributor Author

lambdai commented May 21, 2019

This is not good. ref is more than spelling error. It doesn't give warning on the missing reference. Will fix
this one and root cause later.

@lambdai
Copy link
Contributor Author

lambdai commented May 21, 2019

I realize that this piece of comment is associated with service instead of message

service doc is not generated, let alone validation.

@lambdai
Copy link
Contributor Author

lambdai commented May 21, 2019

created #7030

Signed-off-by: Yuchen Dai <silentdai@gmail.com>
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@mattklein123 mattklein123 merged commit 8a5a83c into envoyproxy:master May 22, 2019
mpuncel added a commit to mpuncel/envoy that referenced this pull request May 22, 2019
* master: (65 commits)
  proto: Add PATCH method to RequestMethod enum (envoyproxy#6737)
  exe: drop unused deps on zlib compressor code (envoyproxy#7022)
  coverage: fix some misc coverage (envoyproxy#7033)
  Enable proto schema for router_check_tool (envoyproxy#6992)
  stats: rework stat sink flushing to centralize counter latching (envoyproxy#6996)
  [test] convert lds api test config stubs to v2 (envoyproxy#7021)
  router: scoped rds (2c): implement scoped rds API (envoyproxy#6932)
  build: Add option for size-optimized binary (envoyproxy#6960)
  test: adding an integration test framework for file-based LDS (envoyproxy#6933)
  doc: update obsolete ref to api/XDS_PROTOCOL.md (envoyproxy#7002)
  dispatcher: faster runOnAllThreads (envoyproxy#7011)
  example: add csrf sandbox (envoyproxy#6805)
  fix syntax of gcov exclusion zone. (envoyproxy#7023)
  /runtime_modify: add support for query params in body (envoyproxy#6977)
  stats: Create stats for http codes with the symbol table. (envoyproxy#6733)
  health check: fix more fallout from inline deletion change (envoyproxy#6988)
  Max heap fix (envoyproxy#7016)
  Add support to unregister from lifecycle notifications (envoyproxy#6984)
  build spdy_core_alt_svc_wire_format (envoyproxy#7010)
  ext_authz: Make sure initiateCall only called once (envoyproxy#6949)
  ...

Signed-off-by: Michael Puncel <mpuncel@squareup.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants