Use Admonitions on website #12495

[paulreece]

Summary

I have changed all of the improperly formatted "note" sections to now use admonitions instead.

Test plan

The code is just markdown edits so I'm sure it will pass all tests.

[facebook-github-bot]

Hi @paulreece!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[mrazauskas]

Thanks! Could you split the PR, please?

That is rather large change and it is hard to review everything in one go.

It would be perfect to keep one file (or two smaller) per PR.

[paulreece]

@mrazauskas So you want me to split out each md file that I edited? Like 20 PRs? There's only a couple of changes per file, just changing the old note style to the admonition style.

[mrazauskas]

Right, but I would like to be able to look through the whole source of each file. Just to make sure that there will be no need to come back to these files.

I did review similar PR previously and to look through one or two file was fine. More is too much.

Also note that in the issue it was agreed to keep the PRs small.

[paulreece]

@SimenB @mrazauskas I split the files into separate PRs. Here ya go:

https://github.com/facebook/jest/pull/13293 https://github.com/facebook/jest/pull/13294 https://github.com/facebook/jest/pull/13295 https://github.com/facebook/jest/pull/13296 https://github.com/facebook/jest/pull/13297 https://github.com/facebook/jest/pull/13298 https://github.com/facebook/jest/pull/13299 https://github.com/facebook/jest/pull/13300 https://github.com/facebook/jest/pull/13301 https://github.com/facebook/jest/pull/13302 https://github.com/facebook/jest/pull/13303 https://github.com/facebook/jest/pull/13304 https://github.com/facebook/jest/pull/13305 https://github.com/facebook/jest/pull/13306 https://github.com/facebook/jest/pull/13307 https://github.com/facebook/jest/pull/13308 https://github.com/facebook/jest/pull/13309 https://github.com/facebook/jest/pull/13311

[mrazauskas]

Perfect! Thank you so much. This is very helpful.

I have left reviews in all the PR. Here is a couple of more general notes:

• it would be perfect to use these PR to update all versions of docs. Right now you touched only the next version, the versioned docs live in website/versioned_docs. See https://github.com/facebook/jest/pull/13284 for an example of a PR which is updating all versions of docs.
• remember to run yarn lint:prettier. I fixed few issues in comments, but might be that Prettier will catch something more.

[paulreece]

@mrazauskas To Clarify were you all wanting admonitions in each of the files in each sub directory of website/versioned_docs?

[mrazauskas]

Thanks a lot for the effort. Just left comments with more details in each PR. Yesterday I was in hurry to look through everything. Hope now all is clarified.

Yes, I had in mind all sub directories of website/versioned_docs. That should make six files per PR with the similar changes in each file. Keep in mind that some notes might not exist in older docs, because some features were added later. If notes are not there, no need to add them, of course.

[SimenB]

Thank you both so much for taking. the time to split this up and review it! ❤️

I've been neck deep in native app development the last couple of weeks (and will for the next few as well) and haven't had the time to dedicate to going through them. So I very much appreciate the bite sized, and reviewed, PRs 👍

---

I think we can close this one, tho, as the others should be merged.

[SimenB]

Note that I'll be rolling a 29.1 version, so the remaining two (#13295 and #13310) should get an additional version before landing 🙂

[paulreece]

@SimenB or @mrazauskas Would it be possible for you to ping me on here when you do roll out the 29.1 versions so I can then update #13295 and #13310 accordingly? Thanks so much to @mrazauskas for taking the time to help me get these revisions ready for production!

[SimenB]

29.1 has been out for about 10 hours 🙂

https://github.com/facebook/jest/releases/tag/v29.1.0

[paulreece]

Awesome thanks!

[github-actions[bot]]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.