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

config stable and dev docs #162

Merged
merged 1 commit into from
Jun 9, 2023
Merged

config stable and dev docs #162

merged 1 commit into from
Jun 9, 2023

Conversation

d-chambers
Copy link
Contributor

@d-chambers d-chambers commented Jun 9, 2023

Description

This PR implements two documentation build/deployments and updates the corresponding links in the readme and top page of the docs.

The two builds are:

stable: deployed at dascore.org and built whenever a new release is made from github (which triggers PyPI/conda releases).

development: deployed at dascore.quarto.pub/dascore and built whenever commits are merged into master.

The problem this solves:

New users install dascore with pip/conda. Then they look at dascore.org, but the code there might not work since currently it is for the master branch (which might be quite different from the previous release). Essentially, this PR should make for a better (less confusing) onboarding experience for new users while still giving us a chance to see up-to-date development (from master branch) docs.

The hosting site for the development docs is (quarto-pub)[https://quartopub.com/], a free site for hosting quarto projects up to 100mb. Dascore's docs are currently ~40mb.

closes #160

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

@d-chambers d-chambers added the documentation Improvements or additions to documentation label Jun 9, 2023
@d-chambers
Copy link
Contributor Author

Unfortunately, there isn't a very good way to test this other than merging it to trigger the appropriate actions, so here it goes...

@d-chambers d-chambers merged commit d847914 into master Jun 9, 2023
@d-chambers d-chambers deleted the two_docs branch June 9, 2023 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant