Fix small typos in the root md files

[PhilippeOberti]

Summary

This small PR fixes a few typos in 3 root level md files:

• FAQ.md
• STYLEGUIDE.mdx
• TYPESCRIPT.md

Notes: I'm on week 3 at Elastic and this is my first PR. Please do not hesitate to close it if this PR is not desired, or if it isn't following the proper standards. I also could not find any guidance on how to format the commit message, so hopefully what I did is OK!

I'm not sure what version this PR should target, as it isn't really code related... should it sill have a label for the version (v8.4.0)?

[PhilippeOberti]

@elasticmachine merge upstream

[elasticmachine]

Pinging @elastic/kibana-core (Team:Core)

[lukeelmers]

Thanks @PhilippeOberti, and welcome!

I'm not sure what version this PR should target, as it isn't really code related... should it sill have a label for the version (v8.4.0)?

For something like this, I think it's fine to just merge into main for the latest minor (currently targeting v8.4.0).

Added a few notes, lmk what you think.

[PhilippeOberti]

Thanks @PhilippeOberti, and welcome!

I'm not sure what version this PR should target, as it isn't really code related... should it sill have a label for the version (v8.4.0)?

For something like this, I think it's fine to just merge into main for the latest minor (currently targeting v8.4.0).

Added a few notes, lmk what you think.

Thanks @lukeelmers! Changes made. While I reverted the . to : changes, I updated some other places which I believe could have used a :. Please let me know if that was unnecessary and I'll revert these as well 😄

One unrelated question: in my previous company we always wanted to have a single commit per PR to keep the commit log as clean as possible. It doesn't seem that Elastic is following this (at least in this Kibana repo). I just rebased against latest main and amended my commit, then force pushed. Hopefully that is ok...?

[lukeelmers]

Thanks for these updates -- I noticed a few other things and added comments below.

in my previous company we always wanted to have a single commit per PR to keep the commit log as clean as possible. It doesn't seem that Elastic is following this (at least in this Kibana repo). I just rebased against latest main and amended my commit, then force pushed. Hopefully that is ok...?

Kibana actually does follow this convention -- when a PR is approved, it is squashed into a single commit upon merging into main.

When you are still developing a PR, feel free to rebase & force push as much as you need to. But once others have started reviewing a PR, we recommend you avoid rebasing as it makes the history of changes much harder to follow for reviewers. Most folks find it easier to review a PR that is grouped into a series of logical commits than a single "Big Bang" commit with all the changes.

If you need to incorporate the latest upstream changes, you can just merge the latest main into your branch (we even have an automated way to do this: commenting @elasticmachine merge upstream on your PR will automatically update it for you).

[PhilippeOberti]

When you are still developing a PR, feel free to rebase & force push as much as you need to. But once others have started reviewing a PR, we recommend you avoid rebasing as it makes the history of changes much harder to follow for reviewers. Most folks find it easier to review a PR that is grouped into a series of logical commits than a single "Big Bang" commit with all the changes.

That makes sense. Just curious then, how do we decide what commit message takes priority? Maybe I'll just research how GitHub auto-squash functionality works :)

@lukeelmers sorry for all the extra formatting, I had enabled some auto-format on save with Webstorm and didn't catch them. Rookie mistake 😞 I've disabled it now...
I've undone all the unnecessary changes, we now have only the wanted changes. Sorry for wasting your time, I'll pay closer attention to this in the future!

[lukeelmers]

Changes LGTM, thanks for working through those!

how do we decide what commit message takes priority?

Github will default to the title of the PR, and include each commit message in the description, but the UI will let you change it to whatever you want :)

sorry for all the extra formatting, I had enabled some auto-format on save with Webstorm and didn't catch them

No worries! All you should need when working with the repo is eslint, and it should help keep everything formatted based on the linting & prettier rules we have defined for the repo. (Of course, it isn't going to format code inside markdown files like this, so 🤷)