Update link to metadata text guidelines in Dataverse style guide #10962
Conversation
Update link to metadata text guidelines in Dataverse style guide
There was a problem hiding this comment.
Two things. The the change to the link itself looks great but the doc is owed by @jggautier
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. 🤔
|
The doc is moved to the shared drive now. |
@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? |
|
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. |
|
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: |
|
@DieuwertjeBloemen what do you think? Merge it? Or do you want to make more changes? |
|
No, looks good like that. |
|
@jggautier any more thoughts on this? Can I merge it? |
|
What you're proposing to merge is changing the link of the text guidelines, right? If so, that's fine with me. There's other conversation in this PR that I think is related but outside of the scope of the issue that this PR is closing. |
|
@jggautier if you look at "files changed" at https://github.com/IQSS/dataverse/pull/10962/files we are also removing a link to a related unused doc. |
|
Ah, I'm not sure. The issue I opened at #10838 is about updating the link. There's interesting conversation surrounding the link you removed to that related unused doc, but I don't have time to contribute to it right now. @DieuwertjeBloemen, this doesn't seem as simple as you thought, right? Can this PR be just about updating the link. And then @pdurbin, can you open a GitHub issue about removing the link to the related unused doc? |
This reverts commit 1012763.
|
I reverted the commit to make this PR the way @DieuwertjeBloemen originally meant it, to only fix the link. I'll go ahead and merge it. As for a new issue, I think I'd rather have a discussion in #docs in Zulip about it at some point about the empty doc. No rush. |
The conversation continues here: https://dataverse.zulipchat.com/#narrow/channel/375707-community/topic/.22Tips.20For.20Dataverse.20Software.20metadata.20blocks.22.20doc.20is.20empty/near/484338733 |
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: