Releases: hubverse-org/hubDocs
Releases · hubverse-org/hubDocs
v5.0.0
What's Changed
- Only show a single target_keys key value pair to conform to v4.0.1 schema by @annakrystalli in #227
Full Changelog: 4.0.0...5.0.0
v4.0.0
This release is the version of the documentation that is compatible with schemas v4.0.0
It also represents major improvements to the documentation with improvements to
accessibility, a new developer section, clarifications of model tasks, output
types, and target data.
What's Changed
- Add warning about effect of derived task ids on compound_taskid_set validation by @annakrystalli in #168
- Add additional info in Structure of Hub Repositories by @mmkerr in #170
- update sphinx, myst, and other things that borked by @zkamvar in #171
- add documenation about validate-config action by @zkamvar in #164
- add a who and a why to the docs by @zkamvar in #172
- add list of active hubs on landing page by @zkamvar in #165
- Update who-we-are.md to include InsightNet funding explicitly by @nickreich in #178
- Update who-we-are.md to include InsightNet JHU/UNC funding by @nickreich in #179
- Adding a "Scripting Task Config" section to the Quickstart guide by @micokoch in #175
- Clarify model-outputs section by @zkamvar in #176
- add missing hyphen by @micokoch in #182
- Clarify modelling tasks by @zkamvar in #173
- remove note on "other things we may consider" by @micokoch in #185
- Fixing uninformative links, grammar, spelling, and some more by @micokoch in #186
- Add mention of "model_output_dir" key in documentation; fix broken crossrefs by @zkamvar in #188
- Remove caution note by @micokoch in #191
- Quickstart uninformative links and Grammarly edits by @micokoch in #189
- Correct modelling section to refer to hubValidations as useful package by @annakrystalli in #196
- Replacing uninformative links, editing with Grammarly and other edits by @micokoch in #195
- Uncapitalize parquet by @micokoch in #199
- redefine model output representation to be two columns by @micokoch in #202
- clarify missingness of point estimates; add examples for determining output_type_id format by @zkamvar in #197
- Add abbreviations page by @micokoch in #206
- Add hubverse roles image by @micokoch in #213
- adding image to roles in documentation page by @micokoch in #214
- collapse navbar elements by @zkamvar in #215
- Update Target Data for updated data standards by @zkamvar in #208
- update output types for v4 by @zkamvar in #218
- add derived task ID language by @zkamvar in #217
- update schema version to v4.0.0 by @annakrystalli in #219
- Minor clarifications on derived and standard task IDs by @annakrystalli in #222
- add documentation about disallowing optional quantiles by @zkamvar in #220
- Update samples for v4 by @zkamvar in #223
- add "identity" to abbreviations by @zkamvar in #224
- Clarify the expected format of round IDs. Resolves #203 by @annakrystalli in #225
- fix syntax highlighting for json code block by @zkamvar in #228
- replace code portion of scripting chapter with link by @zkamvar in #229
- add developer documentation by @zkamvar in #232
- Update copyright year by @micokoch in #234
Full Changelog: 3.0.1...4.0.0
v3.0.1
- Introduction of optional
output_type_id_datatype
property to enable hub administrators to configure and communicate theoutput_type_id
column data type at a hub level. This will allow hubs to override default behaviour of automatically determining the simplest data type that can accomodate output type IDs across all output types when creating hub schema. The setting is also useful for administrators to future proof theoutput_type_id
column from potential issues arising by changes in data type, introduced by new output types after submissions have begun, by settingoutput_type_id_datatype
to the simplest data type from the start, i.e.character
. - Removed restrictive epidemic week formatting requirements for CDF
output_type_id
values. Character output type IDs no longer need to conform to the regex pattern^EW[0-9]{6}
(e.g."EW202240"
).
3.0.0
v3.0.0
- Breaking change: introduction of new
sample
output type id schema specification intasks.json
. The main breaking change is the removal of theoutput_type_id
property insample
. Instead, the collection of samples is defined through a newoutput_type_id_params
object (#70). - Breaking change: The
repository_url
andrepository_host
properties inadmin.json
have been deprecated in favour of a siglerepository
object with separatehost
,owner
andname
properties (#67). - Breaking change: The optional
hub_models
property inadmin.json
has been removed as it's schema could create conflicts with themodel_abbr
andteam_abbr
schema specification in the hub administered `model-metadata-schema.json (#77). - Additional properties are now allowed at the round item property level (#74).
- Host organisation name changed in schema
id
properties tohubverse-org
throughout all schema versions.
v2.0.0
New schema version released. (v2.0.0)
Corrections and additions to documentation contents
v1.0.0
- New schema version released. (v1.0.0)
- Corrections and additions to documentation contents
v0.0.1 - First stable schema release
Merge pull request #29 from Infectious-Disease-Modeling-Hubs/version-…
v0.0.0.9 - Development release
Merge pull request #28 from Infectious-Disease-Modeling-Hubs/misc-doc…