Skip to content

docs/configs/examples: use envoy-dev images#6357

Merged
mattklein123 merged 1 commit intomasterfrom
fix_images
Mar 22, 2019
Merged

docs/configs/examples: use envoy-dev images#6357
mattklein123 merged 1 commit intomasterfrom
fix_images

Conversation

@mattklein123
Copy link
Copy Markdown
Member

We need to think about whether we want to have all of these somehow
reference some type of environment variable that would point to the
right image in the context of the tree the user is looking at, but
given that the trunk documentation may require a master build, this
is more correct.

We need to think about whether we want to have all of these somehow
reference some type of environment variable that would point to the
right image in the context of the tree the user is looking at, but
given that the trunk documentation may require a master build, this
is more correct.

Signed-off-by: Matt Klein <[email protected]>
@mattklein123
Copy link
Copy Markdown
Member Author

cc @bndw @moderation

@moderation
Copy link
Copy Markdown
Contributor

LGTM. Hopefully this will help with people trying out the sandboxes and will align test images to master doco.

Copy link
Copy Markdown
Contributor

@bndw bndw left a comment

Choose a reason for hiding this comment

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

LGTM

@bndw
Copy link
Copy Markdown
Contributor

bndw commented Mar 22, 2019

I think this will immediately help folks, but I wonder if the real source of the friction here is defaulting users to docs/configs/examples at the current HEAD of development, instead of an official release.

Theoretical example

Sarah grabs the latest official release of Envoy from Dockerhub, then heads to the docs for a configuration example. She grabs a simple example and immediately finds it's incompatible! Frustration ensues.

If the majority of docs/configs/examples consumers are Envoy users and not developers, it may make sense to reorganize things to prefer envoyproxy/envoy images and the release branches in Github.

@htuch
Copy link
Copy Markdown
Member

htuch commented Mar 22, 2019

To @bndw's point, we really want docs/config/examples to depend on whether the docs are cut at a release version or not. Sarah should be looking at the docs corresponding to her version, if it comes from Dockerhub at v1.9.1, then the docs should point at configs at that version.

Might need some templating that depends on the build type when the docs are generated.

@mattklein123
Copy link
Copy Markdown
Member Author

I agree which is why I refer to an env variable above (templating is more accurate). Thoughts on still merging this as I think it's getting us back to where we were previously?

Copy link
Copy Markdown
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

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

Sure, fine to merge, maybe file issue.

@mattklein123
Copy link
Copy Markdown
Member Author

I opened #6361. There is a lot to unpack there and I agree with @bndw we can do better. However, I think this gets us back to where we were before so it's worth merging.

@mattklein123 mattklein123 merged commit 260e42a into master Mar 22, 2019
@mattklein123 mattklein123 deleted the fix_images branch March 22, 2019 22:56
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.

4 participants