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

Advertise CI artifacts better #326

Closed
effigies opened this issue Sep 6, 2019 · 0 comments · Fixed by #330
Closed

Advertise CI artifacts better #326

effigies opened this issue Sep 6, 2019 · 0 comments · Fixed by #330

Comments

@effigies
Copy link
Collaborator

effigies commented Sep 6, 2019

We now have a bot that will automatically find the rendered docs in the CircleCI artifacts and create a link in the CI checks at bottom. This could be a bit more flashy or better advertised. A couple options include (in rough order of difficulty):

  1. Add language to the PR template letting people know to look there. Possibly CONTRIBUTING.md as well.
  2. Switch to Netlify as shown in [WIP] Restructure Testing chapter the-turing-way/the-turing-way#613, which seems to perform various checks, render, and make the first comment on a PR. It also edits the comment, rather than re-commenting, keeping an up-to-date rendering at the top of the thread while not overly polluting the comment thread.
  3. Fiddle with the bot to do some of the nice things Netlify does

Follow-up to #315, please refer to discussion there for anything I may have missed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant