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

Update link to metadata text guidelines in Dataverse style guide #10962

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

DieuwertjeBloemen
Copy link
Contributor

@DieuwertjeBloemen DieuwertjeBloemen commented Oct 24, 2024

Preview changes:

Update link to metadata text guidelines in Dataverse style guide

What this PR does / why we need it:
In the documentation page on Text in the style guide, the link lead to a google doc which stated that the document was now located at another location with the link. This PR changes the old link to the new location as mentioned in the google doc.
Which issue(s) this PR closes:

Special notes for your reviewer:
NA
Suggestions on how to test this:
Click on the new link.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No
Is there a release notes update needed for this change?:
No
Additional documentation:

Update link to metadata text guidelines in Dataverse style guide
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Two things. The the change to the link itself looks great but the doc is owed by @jggautier

Screenshot 2024-10-24 at 7 48 12 AM

Can we please move this doc to the shared drive? Otherwise, docs like this are deleted when the g.harvard account is deleted.

Second, what is the relationship between this doc and the empty doc under the Admin Guide? https://guides.dataverse.org/en/6.4/admin/metadatacustomization.html#tips-from-the-dataverse-community says, "Alternatively, you are welcome to request “edit” access to this “Tips for Dataverse Software metadata blocks from the community” Google doc: https://docs.google.com/document/d/1XpblRw0v0SvV-Bq6njlN96WyHJ7tqG0WWejqBdl7hE0/edit?usp=sharing " Again, this doc is empty. 🤔

@jggautier
Copy link
Contributor

The doc is moved to the shared drive now.

@pdurbin
Copy link
Member

pdurbin commented Oct 24, 2024

Tips for Dataverse Software metadata blocks from the community

@qqmyers judging from http://irclog.iq.harvard.edu/dataverse/2018-11-01/#i_77561 you were an advocate for this "tips" doc but it's empty. Should we remove the link to it? And point people to https://dataverse-guide--10962.org.readthedocs.build/en/10962/style/text.html#metadata-text-guidelines instead where they can find an active "guidelines" doc?

Or am I misunderstanding the situation? Should we continue to have two docs?

@qqmyers
Copy link
Member

qqmyers commented Oct 24, 2024

I think there's still useful info in the original doc, particularly about how to delete things (still as suggestions) that I still think should remain unofficial/ caveat emptor. Where that belongs or if it is a link in the guides or not I don't care too much about.

@pdurbin
Copy link
Member

pdurbin commented Oct 24, 2024

@qqmyers ok, but no objection if we remove links to the empty tips doc?

@pdurbin
Copy link
Member

pdurbin commented Oct 24, 2024

I saw a 👍 so I went and and removed the link to the empty doc (and the text around it) in 1012763.

Now that there are two pages that have been modified, I updated the description above to say this:

Preview changes:

@pdurbin
Copy link
Member

pdurbin commented Oct 24, 2024

@DieuwertjeBloemen what do you think? Merge it? Or do you want to make more changes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review 🔎
Development

Successfully merging this pull request may close these issues.

Update link to metadata text guidelines in Dataverse style guide
4 participants