Page preview

[uilianries]

Hi!

As a Gitlab fan I need to expose a feature from there. Gitlab offers a page preview when a PR is open, the Review Apps.

Since we have typo errors, broken links and all prone errors, even when creating docs, we could adopt some service/feature to preview our PR. I think it will help us to find any kind of bad resources, before to download the fork and try on our machine.

/cc @danimtb @jgsogo

[uilianries]

I've looked for a service which could put our PR page in preview mode, so I found this one:

https://htmlpreview.github.io/

But we need to generate all HTML stuff and store in some place, since Travis doesn't offer artifacts download. Some thoughts about:

• We could upload to Bintray as a generic repo and point the link on PR page
• Use Travis to upload all HTML files to the PR branch and remove the build folder just after to merge (all automatically)
• Create preview tags on Github with Travis Artifacts
• Create a mirror on Gitlab to have preview feature (wrost option)

[danimtb]

I think we are not generating the HTML files ourselves but relying on the gh-pages deployment of Github I don't see an easy way of automating the checks.

The only thing would be having a script for spell checks running on travis and reporting back as a check in the PR. Something like this https://blog.eleven-labs.com/en/how-to-check-the-spelling-of-your-docs-from-travis-ci/

For the HTML preview I think it is too much to do the Bintray repo and so on... But maybe we can make travis build the HTML and post it in the PR attached in a comment?

You know, I like the idea of automating but in the end it is just a blog... 📃