gradle-baseline icon indicating copy to clipboard operation
gradle-baseline copied to clipboard

Fix typos and links

Open k3KAW8Pnf7mkmdSMPHz27 opened this issue 2 years ago • 3 comments

Before this PR

  1. Some typos
  2. Switch links from HTTP -> HTTPS (I believe that is safe and recommended these days)
  3. Some links have changed address. The old address is still usable, but these are the addresses you get redirected to

After this PR

==COMMIT_MSG== Fixed typos and link updates ==COMMIT_MSG==

Possible downsides?

  1. One typo is in a markdown header, which can break existing links outside of the readme.
  2. I guess there is an argument to be made that these link doesn't need to be HTTPS

Other

Feel free to comment on any of the changes/commits and I can update them accordingly. I don't have any issues reverting/removing anything in this PR or splitting it over multiple PRs if that makes more sense.

This is just me being nitpicky X)

k3KAW8Pnf7mkmdSMPHz27 avatar Apr 14 '22 12:04 k3KAW8Pnf7mkmdSMPHz27

Generate changelog in changelog/@unreleased

Type

  • [ ] Feature
  • [ ] Improvement
  • [x] Fix
  • [ ] Break
  • [ ] Deprecation
  • [ ] Manual task
  • [ ] Migration

Description Typos and link updates

Check the box to generate changelog(s)

  • [x] Generate changelog entry

changelog-app[bot] avatar Apr 14 '22 12:04 changelog-app[bot]

Hi @k3KAW8Pnf7mkmdSMPHz27 , thanks for your contribution. Overall this looks good, and definitely appreciate fixes & switch from http to https.

I think the original CI automated doc linting in https://github.com/palantir/gradle-baseline/blob/develop/docs/lint.sh by https://github.com/palantir/gradle-baseline/pull/127/ was dropped with the move to Circle templates. I know we've had some problems in the past with build flakes due to doc linting URL check transient failures, but might be worth updating lint.sh to expand the remark rules and add some dead link checks via remark-lint-no-dead-urls and maybe also flag any http schemes so we can warn, but not fail builds to prevent similar future issues.

schlosna avatar Apr 18 '22 20:04 schlosna

Hello @schlosna, thank you for mentioning remark-lint, you just made me go on a one-hour-long Reviewdog tangent ^^

Circle templates. I know we've had some problems in the past with build flakes

I haven't used circle-ci so I can't be useful with that. Creating a new non-required workflow would be my default go-to method

also flag any http schemes so we can warn, but not fail builds to prevent similar future issues.

I am going to dig through remarks-lint's plug-in documentation. It appears to be a more fully-featured markdown-linter than what I've been using elsewhere and creating a workflow that can warn/automate upgrades to HTTPS if the linked-to server supports it would be the icing on the cake.

k3KAW8Pnf7mkmdSMPHz27 avatar Apr 19 '22 15:04 k3KAW8Pnf7mkmdSMPHz27

I haven't had the time to look at this PR in a very long time, and I strongly suspect it is all outdated.

k3KAW8Pnf7mkmdSMPHz27 avatar Oct 29 '23 10:10 k3KAW8Pnf7mkmdSMPHz27