Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow exceptions when blocking external proto docs from being built #10619

Open
Rachael-Graham opened this issue Feb 14, 2025 · 1 comment
Open

Comments

@Rachael-Graham
Copy link

Rachael-Graham commented Feb 14, 2025

Version

main (1.18.x beta)

Gateway API

Gloo Edge API

Describe the requested changes

@sheidkamp developed some logic in https://github.com/solo-io/gloo/pull/10065/files#diff-daddc66424f674dc57b411e63fce1f1bd231a27a77e39d25c781b4a8ca6f6062 to block external API protos from being built into API refenence docs. This decluttered our API reference so that only our Gloo API docs were published, instead of publishing, for example, every envoy proto that we pull in.

However, we inadvertently removed some Gloo EE API protos in the process.
For example:

  • proxylatency is a Gloo API proto (it's an enterprise feature) that we do need the API ref doc for. But because its package is envoy.config.filter.http.proxylatency.v2, it is removed because it looks like one of the envoy external protos.
  • I also think transformation with the package envoy.config.filter.http.transformation_ee.v2 looks like it needs to be built, just based on the ee in the package name

Link to any relevant existing docs

No response

Browser Information

No response

Additional Context

Seth mentioned that "we could have a regex like "github.com/solo-io/gloo/projects/gloo/api/external/[^envoy]" (although that is not the correct syntax and I think go's regexes might be limited in the use of look aheads that are needed to do negative string matching. Passing a filter function might be a cleaner approach."

@sheidkamp
Copy link

Would we want to link the same internal location we had been using before, or should we figure out a way to map out to externally hosted envoy docs?

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

No branches or pull requests

2 participants