envoyproxy / envoyproxy/envoy

Notify on Pull Requests when documentation is rendered in CI

Open
#13,294 4 comments 0 reactions 0 assignees View on GitHub
area/docs help wanted
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 22h
Merged PRs (30d)
430

Description

## description

when you make changes to documentation its rendered by CircleCI.

I think it would be useful for reviewers and contributors if the repo bot posted a message containing a link to the rendered docs.

I can imagine this working in one of 2 ways

### posting the first time a change is noticed (and rendered)

im guessing the condition for this would be similar to the trigger used to notify api-shepherds etc when api changes happen - except for that it should wait until the docs have been rendered

### posting every time docs changes happen (and are rendered)

i think this would be a bit more complex and would involve comparing commits in the PR or perhaps cached artefacts

in some ways this would be more useful - because you would have the most up-to-date link - but in other ways it would be a bit more of a thread-hog

## refs
- https://github.com/envoyproxy/envoy/pull/13268#discussion_r494888882
- https://384272-65214191-gh.circle-artifacts.com/0/generated/docs/index.html
- https://app.circleci.com/pipelines/github/envoyproxy/envoy/34403/workflows/33eaf7f9-214f-4991-aeff-620047b76ea0/jobs/384272

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.