-
Notifications
You must be signed in to change notification settings - Fork 535
Closed
Description
Context
- Since I've opened Compile guides with Maven sphinx plugin #6188, I learned about a few interesting things about Sphinx, see also Groups UI #92.
- In PR 6192 there has been a hint by @pdurbin about building the guides for PRs in EC2.
- I talked about this proposal with @pdurbin today on IRC
Proposal
- Copycat K8s documentation job for Dataverse
- Copycat
JenkinsfileandDockerfilefor 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels