Support public and dev docs site #215
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nmdefries
requested review from
brookslogan,
dshemetov and
dsweber2
as code owners
dshemetov
approved these changes
Nov 14, 2023
Contributor
dshemetov
left a comment
dshemetov
left a comment
There was a problem hiding this comment.
Excellent, thanks Nat! Really appreciate your documentation in DEVELOPMENT.md too.
dsweber2
approved these changes
Nov 14, 2023
Contributor
dsweber2
left a comment
dsweber2
left a comment
There was a problem hiding this comment.
oh, good to know! Needing a 4 point versioning system seems like wild overkill; maybe we could use this pkgdown instead? Up to you as the one actually implementing this.
Contributor
Author
|
Given that the pkgdown action seems pretty unpopular/unknown, let's go with the existing implementation for now. We'll see if it makes the release process too burdensome when that happens next. (That is also manual at the moment; an automated or semi-automated release process would be able to handle the 3<->4 component version switching by itself.) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#213 keeps the doc website updated, but it matches
devrather than any CRAN release. If people go from CRAN to our documentation, they're going to see docs for a version they don't have. However, we'd also like to be able to see a preview of thedevversion of the docs.pkgdownlets you build doc websites from both releases and development branches. This PR turns on that feature, and publishes the doc site on push/pull to bothmain(reinstated to commit 0adb796, whenCRAN-SUBMISSIONwas changed last) anddev. Thedevsite will be available at https://cmu-delphi.github.io/epidatr/dev; main/public at https://cmu-delphi.github.io/epidatr.The dev website must be build from a version with 4 components (e.g.
1.1.1.1). I've added.9000to the version number ondevto meet that requirement, but we'll need to remove it as part of the release process, sincemainneeds to have a 3-part version number.