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

5.13 release documentation issues #9393

Open
donsizemore opened this issue Feb 16, 2023 · 2 comments
Open

5.13 release documentation issues #9393

donsizemore opened this issue Feb 16, 2023 · 2 comments

Comments

@donsizemore
Copy link
Contributor

Good morning,

Two documentation issues with the 5.13 release:

  1. Slava correctly reports that the upgrade instructions present in https://github.com/IQSS/dataverse/blob/develop/doc/release-notes/5.13-release-notes.md aren't visible at https://github.com/IQSS/dataverse/releases/ . This is likely just a display issue; reporting in case there's any GitHub setting that might be adjusted.
  2. The DV-Webloader notes link "Folder Notes" in the guide which link to the DV-Webloader wiki, but the DV-Webloader GitHub repo contains the example API call to enable it. Perhaps we want to link to the repo instead? (happy to submit a PR here)

Thank you,
Don

@pdurbin
Copy link
Member

pdurbin commented Feb 16, 2023

@donsizemore thanks for opening this issue.

Yeah, I don't think we can change how many characters are shown per release note on the list of notes.

For DVWebloader (and other issues that come up), please feel free to edit the release notes directly. We should also add a section called "new database settings" and list :WebloaderUrl. @4tikhonov reminded me of this when he linked me to a script he's using to enable DVWebloader.

I say let's edit the release notes directly because it's more important to have the release notes be accurate than what's in git. Maybe we'll remove git versions eventually:

You might also be saying a PR against the guides themselves. We should probably do that too but until the next version of the guides comes out the current release note will be more useful.

@qqmyers
Copy link
Member

qqmyers commented Feb 16, 2023

How about a link at the top of the release note - "Click here to see the full release note including install instructions"?

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

No branches or pull requests

3 participants