Skip to content

Conversation

@dcslagel
Copy link
Contributor

@dcslagel dcslagel commented Dec 1, 2020

Description:

  • Fix current 404 errors for guidebook links
  • Update PyOpenSci links to guidebook to live links
  • Configure links as references

Testing Notes:

  • Manually clicked on each of the updated links and verified they go to a live url.
  • Note: for some of the PyOpenSci links I made a best guess at correct link. So it would be good for someone to review and let me know if any corrections are needed.

Let me know if this change could be accepted (or rejected) or
needs some additional changes before being approved and merged.

Thank you,
DC

- Update PyOpenSci links to guidebook - Configure links as references
@NickleDave NickleDave self-requested a review December 1, 2020 18:36
@NickleDave
Copy link
Contributor

DC! Thank you for doing this! 🙌 🙏

I also manually clicked and verified the links are working now.
Overall it looks good but will review in more detail this weekend (sorry it can't be sooner, big deadline at work right now).
I see one very minor typo, will comment, but overall this is great, much appreciated!!!

@NickleDave
Copy link
Contributor

And very good idea to convert links to reference style!
I have to admit I actually didn't know about this functionality in Markdown. TIL


[PyOpenSciCodeOfConduct]: https://www.pyopensci.org/contributing-guide/open-source-software-peer-review/code-of-conduct.html?highlight=code%20conduct

[GovernanceIssues]: https://github.com/pyOpenSci/governance/issues/8
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this [GovernanceIssues] link actually used?
I couldn't find another occurrence of it.
Looks like it's the same link as [Comments]?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@NickleDave,

Thank you for reviewing this. Good catch on the unused 'Governance' reference!. I re-reviewed the links and the original versions of the docs and didn't see any reference to it, so it must have be a leftover from deciding between 'Governance' or 'Comment'. I have removed the 'Governance' link in commit abc62b1. So I think this is ready to merge. Let me know if it needs any additional changes.

Thanks

@NickleDave
Copy link
Contributor

@dcslagel sorry I didn't get to this over the weekend.

Overall this looks really good.
Thank you for fixing all these links. Obviously we had a bit of a disconnect between these templates and newer versions of the guidebook.
I double-checked and the links now all seem to point to the right place; a couple are actually better choices than what we had before.

I made one other very minor comment but aside from that I think this PR is ready to merge.

@NickleDave
Copy link
Contributor

🙏 🙏 🙏 🎉 🎉 🎉
Thank you for making that minor fix so quickly.
LGTM.
I will go ahead and merge this in

@NickleDave NickleDave merged commit 7ed3a4c into pyOpenSci:master Dec 8, 2020
@NickleDave
Copy link
Contributor

Thank you again @dcslagel -- I just checked by initiating some issues and all those links seem to be working now.

Much appreciated.
@lwasser ICYMI the links in our issue templates are all correctly resolving now, thanks to @dcslagel

@dcslagel dcslagel deleted the update-pyopensci-links branch December 9, 2020 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants