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

Restore per-commit-head publishing of docs in CI #13535

Closed
phlax opened this issue Oct 13, 2020 · 1 comment · Fixed by #13826
Closed

Restore per-commit-head publishing of docs in CI #13535

phlax opened this issue Oct 13, 2020 · 1 comment · Fixed by #13826
Assignees
Labels
area/docs no stalebot Disables stalebot from closing an issue

Comments

@phlax
Copy link
Member

phlax commented Oct 13, 2020

description

We lost per-commit head publishing of docs moving from circleci -> azure (#13481 )

With the new setup docs are published to eg http://storage.googleapis.com/envoy-pr/PR_ISSUE_NUMBER/docs/index.html

In circleci the docs were published as artifacts, which changed with each push to the PR

This is a feature i use a lot, it allows comparison of rendered changes as the PR progresses. It also means that links/comments to specific renderings of the docs dont become meaningless when the rendering changes (see #13490 for typical thread)

There are a couple of downsides to publishing per-commit

  • the URL is more complex
  • PRs use a lot more disk space

I think these problems can be mitigated - eg by using gitops-type publishing of rendered docs (see discussion #13507 (comment)), and that the advantages outweigh the problems, if we have the available disk space

refs

@phlax phlax added bug triage Issue requires triage labels Oct 13, 2020
@phlax phlax changed the title Restore per-commit head publishing of docs in CI Restore per-commit-head publishing of docs in CI Oct 13, 2020
@mattklein123 mattklein123 added area/docs no stalebot Disables stalebot from closing an issue and removed bug triage Issue requires triage labels Oct 13, 2020
@phlax
Copy link
Member Author

phlax commented Oct 16, 2020

also worth noting that afaict the storage.googleapis rendering is cached, so it can take a while before you see changes to the docs after rebuild

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs no stalebot Disables stalebot from closing an issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants