<html><head><style id="css_styles" type="text/css"><!--blockquote.cite { margin-left: 5px; margin-right: 0px; padding-left: 10px; padding-right:0px; border-left: 1px solid #cccccc }
blockquote.cite2 {margin-left: 5px; margin-right: 0px; padding-left: 10px; padding-right:0px; border-left: 1px solid #cccccc; margin-top: 3px; padding-top: 0px; }
a img { border: 0px; }
table { border-collapse: collapse; }
li[style='text-align: center;'], li[style='text-align: center; '], li[style='text-align: right;'], li[style='text-align: right; '] { list-style-position: inside;}
body { font-family: 'Segoe UI'; font-size: 12pt; }
.quote { margin-left: 1em; margin-right: 1em; border-left: 5px #ebebeb solid; padding-left: 0.3em; }
--></style></head><body><div>Thanks, Teo!</div><div><br /></div><div>I added a new item "Reviewing documentation changes" to the list of working conventions here: <a href="https://gitlab.haskell.org/ghc/ghc/-/wikis/contributing#working-conventions" style="font-size: 12pt;">https://gitlab.haskell.org/ghc/ghc/-/wikis/contributing#working-conventions</a>.</div><div>Feel free to improve.</div><div><br /></div><div>Sebastian</div>
<div style="clear:both"><br /></div>
<div><br /></div>
<div>
<div>------ Originalnachricht ------</div>
<div>Von "Teofil Camarasu" <<a href="mailto:teofilcamarasu@gmail.com">teofilcamarasu@gmail.com</a>></div>
<div>An "GHC developers" <<a href="mailto:ghc-devs@haskell.org">ghc-devs@haskell.org</a>></div>
<div>Datum 30.05.2024 00:03:24</div>
<div>Betreff Documentation previews on Gitlab pipelines</div></div><div><br /></div>
<div id="xdf3e17a9e7dd4b6"><blockquote cite="CAPBO51EB_cJ9gsJJ8aOPXikHGjhb1uQcV321tQqT1wRwx_Lw7g@mail.gmail.com" type="cite" class="cite2">
<div dir="ltr">Hi folks,<div><br /></div><div>I just wanted to advertise that it is now possible to see rendered previews of documentation changes (haddocks/user guide/etc) on Gitlab pipelines.</div><div><br /></div><div>To access this you need to:</div><div>1. Wait for a pipeline to complete.</div><div>2. From the MR page, click on "Expand" under the pipeline widget, then "Documentation Preview"</div><div>3. This takes you to the job artefacts. Then open `docs/index.html`.</div><div>4. Gitlab will then redirect you to the hosted page.</div><div><br /></div><div>Alternatively instead of (2) you can open the "docs-tarball" job directly and click on "Browse" to go to the artefacts.</div><div><br /></div><div>I've also attached a screen recording to make it a bit clearer.</div><div><br /></div><div>I actually set this up a few weeks ago in <a href="https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12415">!12415</a>. But I forgot to advertise this more widely at the time. And Gitlab isn't super helpful in directing users to it. So, I realised most folks probably don't know it exists.</div><div><br /></div><div>Cheers,</div><div>Teo</div></div>
</blockquote></div>
</body></html>