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

docs: Update build instructions for docs #13268

Merged
merged 8 commits into from
Sep 30, 2020

Conversation

phlax
Copy link
Member

@phlax phlax commented Sep 25, 2020

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

Commit Message: docs: Update build instructions for docs
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue] Partial fix for #13229
[Optional Deprecated:]

Signed-off-by: Ryan Northey <ryan@synca.io>
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
docs/README.md Show resolved Hide resolved
Copy link
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.

Thanks, this is a nice improvement!
/wait

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
docs/README.md Outdated
This can be done as follows:

```
./ci/run_envoy_docker.sh 'ci/do_ci.sh docs'
Copy link
Member

Choose a reason for hiding this comment

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

One extra ask. I'm about to add some additional validation stuff to the docs target for CI checking on external dependency metadata that feeds into docs. Can you make a fork of this docs target called dev_docs (or something like that), so that we don't have developers running the more expensive target locally?

Copy link
Member Author

Choose a reason for hiding this comment

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

Its not actually necessary to use the do_ci.sh script at all - ie you can use docs/build.sh directly inside the container.

Ive updated to use build.sh

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

phlax commented Sep 30, 2020

i think the mac test fail is unrelated - its been failing all day on the brew update

Copy link
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.

LGTM, thanks!

@htuch htuch merged commit 2cdba36 into envoyproxy:master Sep 30, 2020
@phlax phlax mentioned this pull request Oct 2, 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.

3 participants