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

Docs reference master instead of prod #2756

Closed
ryanlovett opened this issue Sep 14, 2021 · 2 comments
Closed

Docs reference master instead of prod #2756

ryanlovett opened this issue Sep 14, 2021 · 2 comments
Assignees
Labels
bug documentation Issues around adding and modifying docs

Comments

@ryanlovett
Copy link
Collaborator

Bug description

https://github.com/berkeley-dsep-infra/datahub/blame/staging/docs/admins/howto/new-packages.rst#L58

We have no master branch, only prod.

Environment & setup

docs.datahub.berkeley.edu

How to reproduce

master is referenced multiple times in https://docs.datahub.berkeley.edu/en/latest/admins/howto/new-packages.html?highlight=master#submitting-a-pull-request.

@ryanlovett ryanlovett added bug documentation Issues around adding and modifying docs labels Sep 14, 2021
@balajialg
Copy link
Contributor

balajialg commented Sep 14, 2021

Thanks for raising this @ryanlovett! Any idea where is the repository that hosts this jupyter book? I hope it isn't an old version using Jekyll as that might involve additional tasks to upgrade to the latest version using Sphinx.

@yuvipanda
Copy link
Contributor

yuvipanda commented Oct 7, 2021

When https://github.com/berkeley-dsep-infra/datahub/blame/staging/docs/admins/howto/new-packages.rst#L58 is modified and merged, it'll automatically be built and deployed to docs.datahub.berkeley.edu by readthedocs.io.

The documentation in this repo uses fairly vanilla sphinx. To test how it looks locally, you can:

cd docs
pip install -r requirements.txt
make html
open docs/_build/html/index.html

balajialg added a commit that referenced this issue Oct 12, 2021
Updating PR documentation for issue #2756
balajialg added a commit that referenced this issue Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Issues around adding and modifying docs
Projects
None yet
Development

No branches or pull requests

3 participants