Skip to content

New documentation for js-dataverse v2#118

Merged
MellyGray merged 56 commits intodevelopfrom
113-documentation-v2
Feb 23, 2024
Merged

New documentation for js-dataverse v2#118
MellyGray merged 56 commits intodevelopfrom
113-documentation-v2

Conversation

@GPortas
Copy link
Contributor

@GPortas GPortas commented Jan 24, 2024

What this PR does / why we need it:

Adds updated and structured documentation to the package, for its next release to version 2.

The docs include a section dedicated to use cases, which includes a description and example calls for each of the use cases available in the package.

Which issue(s) this PR closes:

Related Dataverse PRs:

  • None

Special notes for your reviewer:

Suggestions on how to test this:

MellyGray and others added 10 commits February 19, 2024 12:23
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…nloadSize

Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
@GPortas GPortas self-assigned this Feb 19, 2024
@MellyGray MellyGray removed their assignment Feb 19, 2024
Copy link
Contributor

@MellyGray MellyGray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GPortas There's an integration test failing. I think is some kind of race condition, where sometimes there are more dataset locks occurring than those expected by test's assertion

@GPortas GPortas assigned ekraffmiller and unassigned GPortas Feb 21, 2024
@GPortas GPortas requested a review from ekraffmiller February 21, 2024 13:05
@ekraffmiller ekraffmiller removed their assignment Feb 23, 2024
@MellyGray
Copy link
Contributor

LGTM! For future iterations, I would suggest adding a "Go Back to Index" button on all the documentation pages, as it can be frustrating trying to navigate back to the index

@MellyGray MellyGray merged commit 78558d9 into develop Feb 23, 2024
@MellyGray MellyGray deleted the 113-documentation-v2 branch February 23, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create new documentation for version 2.0.0

4 participants