Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing flags for the astro check command #8237

Merged
merged 5 commits into from May 13, 2024
Merged

Add missing flags for the astro check command #8237

merged 5 commits into from May 13, 2024

Conversation

lifeisfakenews
Copy link
Contributor

Description (required)

Added the flags that are missing from the current documentation for the astro check cli command
Currently, only the --watch flag is documented, however there are several other options available for the command (--minimumSeverity or --preserveWatchOutput for example)

Related issues & labels (optional)

@vercel Vercel
Copy link

vercel bot commented May 9, 2024 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 13, 2024 5:59pm
docs-i18n 🔄 Building (Inspect) Visit Preview 💬 Add feedback May 13, 2024 5:59pm

@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Vercel 🥳

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented May 9, 2024 •
edited

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en reference/cli-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

at-the-vr
at-the-vr reviewed May 10, 2024
View reviewed changes
Copy link
Contributor

@at-the-vr at-the-vr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great PR 🙌 Got 1 suggestion to checkout

src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
@lifeisfakenews @at-the-vr
Update src/content/docs/en/reference/cli-reference.mdx
8755c32 
Use suggested description for `--preserveWatchOutput` flag

Co-authored-by: Atharva <atharvapise19@gmail.com>
sarah11918
sarah11918 reviewed May 12, 2024
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for participating in this issue, and then coming in to improve the docs @lifeisfakenews ! This is a super helpful way to contribute, and we're so glad you did!

I've edited some wording a bit, to keep it consistent with our structure on the rest of the page. Also, there's one particular flag that needs a bit of clarification to make the definition the most helpful, I think. Can you take a particular look at that one, and seeing the format of the others, help us get that one in a similar state?

src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/cli-reference.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member

And @at-the-vr thank you for doing a first review tech check on this! It's so helpful! Take a look at the comments I gave on my editing pass (checking for consistent wording on other parts of the page etc.) and feel free to edit more anytime you want to up your review game and check for things like that! 🙌

@lifeisfakenews
Copy link
Contributor Author

Reworded slightly to follow your suggestions and improved the description for that flag

sarah11918
sarah11918 approved these changes May 13, 2024
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is looking great! @at-the-vr , would you do one final review on this, and when you're happy, I'm happy!

at-the-vr
at-the-vr approved these changes May 13, 2024
View reviewed changes
Copy link
Contributor

@at-the-vr at-the-vr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets Git it Merge 💪

@sarah11918 sarah11918 merged commit ae77d55 into withastro:main May 13, 2024
7 of 8 checks passed
@huyikai huyikai mentioned this pull request May 14, 2024
Merged
wpplumber pushed a commit to wpplumber/astro-docs that referenced this pull request May 15, 2024
@lifeisfakenews @at-the-vr
@sarah11918 @wpplumber
Add missing flags for the astro check command (withastro#8237)
ea3bf08 
Co-authored-by: Atharva <atharvapise19@gmail.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
wpplumber pushed a commit to wpplumber/astro-docs that referenced this pull request May 15, 2024
@lifeisfakenews @at-the-vr
@sarah11918 @wpplumber
Add missing flags for the astro check command (withastro#8237)
d60be02 
Co-authored-by: Atharva <atharvapise19@gmail.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
wpplumber pushed a commit to wpplumber/astro-docs that referenced this pull request May 15, 2024
@lifeisfakenews @at-the-vr
@sarah11918 @wpplumber
Add missing flags for the astro check command (withastro#8237)
d4887da 
Co-authored-by: Atharva <atharvapise19@gmail.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
thomasbnt added a commit to thomasbnt/docs that referenced this pull request May 15, 2024
@thomasbnt
i18n(fr): Update reference/cli-reference.mdx from withastro#8237
0adbc55 
Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>
@thomasbnt thomasbnt mentioned this pull request May 15, 2024
Merged
@jsparkdev jsparkdev mentioned this pull request May 17, 2024
Merged
dreyfus92 added a commit that referenced this pull request May 18, 2024
@thomasbnt @dreyfus92
i18n(fr): Update reference/cli-reference.mdx from #8237 (#8284)
4cef94b 
Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

@at-the-vr at-the-vr at-the-vr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Astro check command missing flags
4 participants
@lifeisfakenews @astrobot-houston @sarah11918 @at-the-vr