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

Idea: Move "Managing Datasets and Dataverse Collections" under API Guide #8539

Closed
kaitlinnewson opened this issue Mar 28, 2022 · 6 comments
Closed

Comments

@kaitlinnewson
Copy link
Contributor

Overview of the Feature Request

As someone frequently using the User Guide, I often have a hard time finding the page "Managing Datasets and Dataverse Collections", which is primarily made up of API commands. It is currently under Admin Guide, but I would like to recommend moving it under the API section instead. I am happy to make a PR for this if others agree.

What kind of user is the feature intended for?
API Users looking for documentation.

What inspired the request?
I have a hard time finding this page! But I'm starting with an issue before a PR in case others feel differently.

What existing behavior do you want changed?
The location of the "Managing Datasets and Dataverse Collections" page.

Any brand new behavior do you want to add to Dataverse?
No

Any related open or closed issues to this feature request?
No

@donsizemore
Copy link
Contributor

seconded: #8527 (comment)

@pdurbin
Copy link
Member

pdurbin commented Mar 28, 2022

@kaitlinnewson no objection but rather than a wholesale removal, on the "Managing Datasets and Dataverse Collections" can you please leave the headers and link to the sections of the API Guide? That's what we do at https://guides.dataverse.org/en/5.10/admin/user-administration.html (screenshot below).

Screen Shot 2022-03-28 at 4 07 57 PM

Here's the rst:

Merge User Accounts
---------------------

See :ref:`merge-accounts-label`

Change User Identifier
-------------------------

See :ref:`change-identifier-label`

Delete a User
-------------

See :ref:`delete-a-user`

Deactivate a User
-----------------

See :ref:`deactivate-a-user`

Hmm. I see there are a lot of headings under "Managing Datasets and Dataverse Collections"...

Screen Shot 2022-03-28 at 4 12 17 PM

... if what I'm suggesting sounds unreasonable, please let me know.

@poikilotherm
Copy link
Contributor

poikilotherm commented Mar 29, 2022

@pdurbin
Copy link
Member

pdurbin commented Apr 15, 2022

Here's a related issue where I'm looking for a place in the guides to link to scripts that the community has written for migrating data into Dataverse:

@jggautier
Copy link
Contributor

Just mentioning that the issue at #8120 is related.

@pdurbin
Copy link
Member

pdurbin commented Nov 11, 2023

@pdurbin pdurbin closed this as not planned Won't fix, can't repro, duplicate, stale Nov 11, 2023
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

6 participants