Skip to content

Discussion: Doc rendering + hosting on PR #52

Description

@SwayamInSync

Opening this issue for discussion on doc building and rendering at PR time

The constraint is current actions used to deploy docs rely the Github pages setting of "Build And Deployment" to be set to "Github Actions". We can enable the doc building at PR time but a preview is not possible with this (AFAIK) because this requires to dump the build files in a branch and then host from there i.e. set "Build And Deployment" to "Branch".
As a workaround there are 3rd party actions integrated with services like Netlify, Surge.sh or Cloudflare that allow us to keep the current "Build And Deployment" settings and still able to host the files over a temporary URL, this requires some secret environment creation and integration into workflow.

The point of raising this discussion is to see if strength agrees for just building is enough then we are GTG right now (#53), but in case preview is demanded then the above mentioned setup would be required. Please let me know your thoughts and if there exists an even simpler way 😄

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions