Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
poikilotherm opened this issue Oct 24, 2019 · 2 comments
Closed

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

poikilotherm opened this issue Oct 24, 2019 · 2 comments

Comments

@poikilotherm
Copy link
Contributor

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.

@poikilotherm
Copy link
Contributor Author

poikilotherm commented Oct 27, 2019

While looking more into this, I came across #2148.

And https://readthedocs.org/projects/Dataverse

Does anyone know if something officially ever happened at ReadTheDocs?

@pdurbin
Copy link
Member

pdurbin commented Jul 29, 2022

Closing. Implemented in this PR by @poikilotherm

Thanks, @poikilotherm !

@pdurbin pdurbin closed this as completed Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants