suzieq icon indicating copy to clipboard operation
suzieq copied to clipboard

Fix a few markdown hyperlinks

Open mjbear opened this issue 1 year ago • 2 comments

Test inclusion requirements

In case the PR contains an enhancement or a new platform/service support, some tests have to be added for the new functionality:

  • any fix or enhancement SHOULD include relevant new tests or test updates, if any tests need updating.
  • a new platform support MUST include the relevant input files similar to what we have in tests/integration/sqcmds/-input directories, along with the relevant tests in the tests/integration/sqcmds/-samples dir. That list MUST include the all.yml file fully filled out.
  • any new service (or table) addition MUST include comments about what network OS are supported (along with version) with this command along with test samples for those platforms and input files in the *-input dir

For additional information about tests, follow this link

Related Issue

n/a

Description

Fix the markdown for a couple of hyperlinks in README.md

Type of change

  • Documentation update

New Behavior

None - documentation update

Contrast to Current Behavior

None - documentation update

Discussion: Benefits and Drawbacks

No drawbacks as the documentation changes (hyperlinks) are cosmetic The fixes adds "polish" to the README.md Backwards compatibility doesn't apply to my README.md fixes

Changes to the Documentation

This PR is to update documentation.

Proposed Release Note Entry

Fix markdown formatting for a few hyperlinks in README.md

Comments

Relatively minor PR.

I may bring it up elsewhere, but the develop branch is nearly 60 commits behind master. (Or rather master says it is nearly 60 commits ahead of develop.) My feature branch is off of develop like the contributing docs instructed.

Double Check

  • [x] I have read the comments and followed the CONTRIBUTING.md.
  • [x] I have explained my PR according to the information in the comments or in a linked issue.
  • [x] My PR source branch is created from the develop branch.
  • [x] My PR targets the develop branch.
  • [x] All my commits have --signoff applied

mjbear avatar Aug 10 '24 23:08 mjbear