Skip to content

docs: Update examples developer documentation#13200

Merged
mattklein123 merged 8 commits intoenvoyproxy:masterfrom
phlax:verify-examples-docs-running
Oct 6, 2020
Merged

docs: Update examples developer documentation#13200
mattklein123 merged 8 commits intoenvoyproxy:masterfrom
phlax:verify-examples-docs-running

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Sep 21, 2020

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs: Update examples developer documentation
Additional Description:

Add documentation regarding:

  • build configs tests/exclusions
  • verifying examples

Risk Level: low
Testing:
Docs Changes: yep
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue] Fix #13058 Fix #13084
[Optional Deprecated:]

Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@dio
Copy link
Copy Markdown
Member

dio commented Sep 23, 2020

Please let me know when it is no longer a WIP. Thanks!

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Oct 3, 2020

/retest

@repokitteh-read-only
Copy link
Copy Markdown

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13200 (comment) was created by @phlax.

see: more, trace.

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the verify-examples-docs-running branch 3 times, most recently from bea25bd to 62adcb8 Compare October 6, 2020 08:48
phlax added 2 commits October 6, 2020 09:49
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the verify-examples-docs-running branch from 62adcb8 to 8627bfc Compare October 6, 2020 09:02
phlax added 2 commits October 6, 2020 10:16
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>

---

One way to run the tests in an isolated environment is to mount the `envoy` source into a `docker-in-docker` container
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

this could do with being expanded upon in some way, but i would rather not do it in this pr

my way of doing this is a little involved - so it would be easier to think about after

i would have added a todo but its not easy/possible in markdown

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Oct 6, 2020

hey @dio - should be ready for review i think

@phlax phlax changed the title [WIP] docs: Update examples developer documentation docs: Update examples developer documentation Oct 6, 2020
Copy link
Copy Markdown
Member

@dio dio left a comment

Choose a reason for hiding this comment

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

Thanks, @phlax!

@mattklein123 mattklein123 merged commit dc7066d into envoyproxy:master Oct 6, 2020
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.

safer example runner Add some docs for verify_build_configs

3 participants