Skip to content

Building docs for PRs and maybe guides.dataverse.org #6315

@poikilotherm

Description

@poikilotherm

Context

Proposal

  • Copycat K8s documentation job for Dataverse
  • Copycat Jenkinsfile and Dockerfile for Sphinx builds from IQSS/dataverse-kubernetes for Dataverse
  • Adapt both to run on PRs, tags etc.
  • Adapt Jenkins pipeline deployment steps to reflect the following pattern in a repository, branch or other webserver: https://<guides URL>/<branchname/tag/latest>/....
    This is planned for IQSS/dataverse-kubernetes anyway.

Computing Resources

This proposal re-uses existing community Jenkins server. That server should be more than enough to build the docs. No AWS machinery necessary.

The builded docs need to live somewhere. Be it on a separate GitHub repository (e. g. "IQSS/dataverse-docs"), a gh-pages branch of IQSS/dataverse or some other webspace. GitHub pages seems like a natural place. Using a separate repository enables write access for @dataversebot without headaches for IQSS/dataverse.

Time resources

Reusing existing scripts, etc. Low amount of time once done for IQSS/dataverse-kubernetes.
Needs some decisions and maybe admin time to create repositories, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions