Fixing a wrong Note header. #1776
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kakabisht
requested review from
btat,
LucasSaintarbor and
sunilarjun
as code owners
btat
requested changes
Apr 30, 2025
Comment on lines
+19
to
+22
| >**Note:** Vagrant requires plugins to create VirtualBox VMs. Install them with the following commands: | ||
|
|
||
| `vagrant plugin install vagrant-vboxmanage` | ||
|
|
||
| `vagrant plugin install vagrant-vbguest` | ||
| * `vagrant plugin install vagrant-vboxmanage` | ||
| * `vagrant plugin install vagrant-vbguest` |
There was a problem hiding this comment.
Docusaurus supports admonitions, which should be used instead. I can't add a suggestion directly due to the way the diff is rendered, but it should look like this:
:::note
Vagrant requires plugins to create VirtualBox VMs. Install them with the following commands:
- `vagrant plugin install vagrant-vboxmanage`
- `vagrant plugin install vagrant-vbguest`
:::
Also:
- With the current suggestion, the list is disjointed from the blockquote. The list needs to be part of the blockquote.
- This page already uses
-for list items so we should keep it consistent. Not a hard requirement, but we generally use-instead of*for list items for readability for cases where the first word is bold or italicized.
|
Closing this PR, since the commits are unverified. Refer to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The note heading in Vagrant Quick Start should be an infobox.
I have made the changes in all the versions of the docs.