Skip to content

Versioning the HoloViz sites #244

@maximlt

Description

@maximlt

The HoloViz sites aren't versioned, while Read the Docs offers this option by default. As such I think many (most?) documentation sites HoloViz users generally visit are versioned, except the HoloViz sites of course.

Most HoloViz sites are hosted on GitHub pages. This is practical but reaches its limit I think when it comes to versioning the sites as a built site is pretty heavy (e.g. 200MB for Panel) and versioning means accumulating multiple built sites in a branch, we'll probably hit some limits quickly.

HoloViews isn't hosted on GitHub pages but on S3. Its built site was already too heavy at the time?

Two options seem to be available.

Read the Docs

From Read the Docs site:

Read the Docs Community:

  • 15 minutes build time
  • 3GB of memory
  • 2 concurrent builds

We can increase build limits on a per-project basis. Send an email to [email protected] providing a good reason why your documentation needs more resources.

If your business is hitting build limits hosting documentation on Read the Docs, please consider Read the Docs for Business which has much higher build resources.

Most of our builds currently last longer than 15 minutes. Read the Docs can apparently extend the build time on a per-project base, so I think it's worth considering.

Custom

Probably following HoloViews' footsteps we could host the sites (all the sites really) on S3 implementing our own versioning structure. Bokeh seems to be doing something similar, from which we could draw inspiration from:

https://github.com/bokeh/bokeh/blob/0326ae1c0a52213bbe62a4624f3621af3e03affe/release/deploy.py#L49-L65

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions