Fix markdown links

[samm-git]

Hi, while implementing my own issuer, I found that the links in README.md are broken, so I decided to submit this PR.

[wallrj]

These links are not broken.
They are Markdown Link Reference definitions.
The intention is to avoid cluttering the paragraphs with long URLs, and instead adding those URLs as references.

They work well when you look at the rendered README in GitHub.

[samm-git]

For whatever reason, it does not work for me, neither in GitHub nor the VS Code preview, links section is just empty:

[erikgb]

Thanks! 🚀

/lgtm
/approve

[cert-manager-prow]

@erikgb: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Thanks! 🚀

/lgtm
/approve

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[cert-manager-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: erikgb
Once this PR has been reviewed and has the lgtm label, please assign wallrj for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[erikgb]

@wallrj, sorry! I noticed your comments on this PR just now. Don't know how I could overlook it... 🙈

[samm-git]

@wallrj @erikgb i still dont think that it works as expected, links section renders empty for me

[erikgb]

@samm-git Links on https://github.com/cert-manager/sample-external-issuer/blob/main/README.md render perfectly fine in my browser. Which client is not working for you? In your screenshot in #57 (comment), I see a single link. Doesn't the link work for you? I notice that the final "Links" paragraph is empty, but I don't think just in-lining the links is the correct fix for this.

[erikgb]

I have just opened up an alternative PR to fix this rather confusing empty "Links" paragraph: #61. PTAL!

[wallrj]

I'd just remove the ## Links heading.

When I wrote this content, I thought it looked weird to just include a bunch of links after the final paragraph, so I added a heading. I imagined (but didn't check) that the link reference definitions would show up when rendered in GitHub.

[samm-git]

whatever works best :) I never used such .md syntax before, so I apologize for the confusion. Either removing Links section or convert it to list of reference would work

[wallrj]

I approved #61. Thanks both of you for noticing this and fixing the problem.