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

documentation: update Native API examples #6083

Closed
donsizemore opened this issue Aug 9, 2019 · 3 comments
Closed

documentation: update Native API examples #6083

donsizemore opened this issue Aug 9, 2019 · 3 comments

Comments

@donsizemore
Copy link
Contributor

Related to #2174 and #930 and #1381 but focusing on a smaller chunk: the Native API examples in http://guides.dataverse.org/en/latest/api/native-api.html are sometimes complete, sometimes make assumptions of the user, and in a few cases contradict one another.

A rising graduate student here would like to learn more about Dataverse, Git, and contributing code to open source, so she's agreed to graciously test and update curl examples. Pull request forthcoming.

@pdurbin
Copy link
Member

pdurbin commented Aug 9, 2019

@donsizemore fantastic! Please be aware that if she starts immediately, she's very likely to encourage merge conflicts with the improvements I'm hoping to make to the API Guide before my talk on Tuesday: https://groups.google.com/d/msg/dataverse-community/V5WkMGDS4VI/maxXTdmzDwAJ

It could be a good opportunity to learn about how to resolve merge conflicts, I suppose. 😄

Also, once we know her GitHub username, we can add her to https://github.com/orgs/IQSS/teams/dataverse-readonly/members , assign this issue to her, and move it to the "Community Dev" column on our board at https://github.com/orgs/IQSS/projects/2 . This helps us remember what people are working on. 😄

donsizemore pushed a commit to uncch-rdmc/dataverse that referenced this issue Aug 9, 2019
@pdurbin
Copy link
Member

pdurbin commented Aug 20, 2019

@donsizemore hi! Would you and/or the rising graduate student like to review pull request #6107 ? I rewrote a few of the curl commands in the Native API section and I hope you like the direction I'm taking. 😄 Feedback welcome!

@donsizemore
Copy link
Contributor Author

In the spirit of "small chunk" updates, I'm closing this in favor of tickets to accompany smaller batches of documentation changes, say updating the example syntax in the "Dataverses" section, then Datasets, and so on.

pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
… Dataset in a Dataverse' section of Native API.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
…Metadata Blocks from Its Parent' section of Native API.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 24, 2020
…etadata Blocks from Its Parent' section of Native API.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 27, 2020
… unpublished Dataverse' section of Native API.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 29, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Jan 29, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 17, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 17, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 17, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 17, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 17, 2020
kcondon added a commit that referenced this issue Feb 18, 2020
…e-API-examples-file4

#6083 update examples in File part of Native API: 'Uningest a File' section.
kcondon added a commit that referenced this issue Feb 18, 2020
…e-API-examples-reingest-a-file

#6083 update examples in File part of Native API: 'Reingest a File' section
kcondon added a commit that referenced this issue Feb 18, 2020
…e-API-examples-redetect-file-type

#6083 update examples in File part of Native API: 'Redetect File Type' section
kcondon added a commit that referenced this issue Feb 19, 2020
…e-API-examples-replacing-files

#6083 update examples in File part of Native API: 'Replacing Files' section
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 20, 2020
kcondon added a commit that referenced this issue Feb 20, 2020
…e-API-examples-getting-file-metadata

#6083 update examples in File part of Native API: 'Getting File Metadata' section
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 21, 2020
pkiraly added a commit to pkiraly/dataverse that referenced this issue Feb 21, 2020
kcondon added a commit that referenced this issue Feb 21, 2020
…e-API-examples-updating-file-metadata

#6083 update examples in File part of Native API: 'Updating File Metadata' section.
kcondon added a commit that referenced this issue Feb 21, 2020
…e-API-examples-editing-variable-level-metadata

#6083 update examples in File part of Native API: 'Editing Variable Level Metadata' section.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Mar 2, 2020
kcondon added a commit that referenced this issue Mar 6, 2020
…e-API-examples-provenance-metadata

#6083 update examples in File part of Native API: 'Provenance' section.
pkiraly added a commit to pkiraly/dataverse that referenced this issue Mar 9, 2020
kcondon added a commit that referenced this issue Mar 10, 2020
…e-API-examples-datafile-integrity

#6083 update examples in File part of Native API: 'Datafile Integrity' section.
kcondon added a commit that referenced this issue Jan 30, 2023
Fix at 'Show the dataset whose id is passed' section #6083
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants