Run website formatter over website_docs

[chalin]

• This is preparation for enabling markdown formatting checks over the Go website docs:
  Enable Prettier check over instrumentation/go & update go opentelemetry.io#2380
• Contributes to CI: check file formatting, including markdown opentelemetry.io#1063
• Runs Pettier over website_docs/*.md
• Replaces relref link(s) by standard markdown link(s)
• Fixes code-block languages for commands

/cc @cartermp @svrnm

[chalin]

Link checking (for both internal and external links) is passing when I run this PR through the website's link checker. I'm not quite sure why the "check-links" action is failing.

[chalin]

Link checking is passing now. I added ignore rules to the Lychee ignore file.

[dmathieu]

This may be planned. But how about running the formatter in an action and checking that the working directory is still clean, to ensure we don't introduce formatting issues in future changes?

[dmathieu]

This seems specific to your local setup. Would there be a way for you to setup a global lycheeignore file?

[chalin]

No, this isn't local to my setup. The build of this PR was failing earlier because of check-links errors, https://github.com/open-telemetry/opentelemetry-go/actions/runs/4238014997/jobs/7364617339:

[dmathieu]

Gotcha. I'd suggest adding a comment specifying this path is for GH Actions. But it seems lycheeignore doesn't allow comments 😞

[chalin]

Thanks for the review @dmathieu.

This may be planned. But how about running the formatter in an action and checking that the working directory is still clean, to ensure we don't introduce formatting issues in future changes?

The plan is to migrate the Go website_docs to the OTel website repo (ideally as soon as possible), per

• Ensure non-API docs are hosted on opentelemetry.io opentelemetry.io#833

OTel Go is the last of the language SIGs to have their core non-API docs migrated. The website has the CI checks in place already so I don't think that it's worth setting up an action in this repo.

The OTel website team is eager to the Go docs migrated, so if there's anything we can do to help make that happen, let us know!

[chalin]

The website has the CI checks in place already

Correction: the CI formatting checks are in place for most of the website docs, but pending for the Go docs; they'll be introduced for Go via:

• Enable Prettier check over instrumentation/go & update go opentelemetry.io#2380

[cartermp]

FWIW @dmathieu we did discuss moving the docs in a Go SIG a little while back -- the main thing is we (well, realistically me) need to address some concerns in the Getting Started side of things and work out a good way to make sure that the sample apps in this repo and docs both reflect the right way to use the SDK.

[chalin]

I'd vote to migrate the docs to the website, without waiting for the said updates :).

[chalin]

In the meantime, is this good to go?

[chalin]

Thanks for merging!

[chalin]

@dmathieu - "CI formatting checks for Go docs" PR is ready for review, FYI:

• Enable Prettier check over instrumentation/go & update go opentelemetry.io#2380