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.

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

Add sections to editor-setup about Prettier and ESLint #831

Merged
merged 9 commits into from
Jun 27, 2022

Conversation

Princesseuh
Copy link
Member

@Princesseuh Princesseuh commented Jun 24, 2022

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)
  • New or updated content
  • Translated content
  • Changes to the docs site code
  • Something else!

Description

Added a section to the Editor Setup page about how to setup Prettier and ESLint.

For ESLint, I opted to simply link the the plugin's User Guide. My reasoning being that being an unofficial plugin, changes might change the installation / configuration process without us noticing. (And it shouldn't be the burden of the community members maintaining it to update our docs, in my opinion.)

For Prettier, I documented how to install it and use it in a CLI scenario in our docs and left a link to the README for further information on how to use it in VS Code and possible settings. I however documented how to make it work in pnpm because it's an issue people encounter very very frequently, to the point where people often think the plugin is broken

This PR also fix a slight mistake in the remote url inside CONTRIBUTING.md

Fix #425

@netlify
Copy link

netlify bot commented Jun 24, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit fc1ff53
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/62b9d5a64d92b0000809f5ea
😎 Deploy Preview https://deploy-preview-831--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Princesseuh Princesseuh marked this pull request as ready for review June 24, 2022 15:46
@sarah11918 sarah11918 added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Jun 24, 2022
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks so much for this @Princesseuh — this is really great. I’ve made some minor suggestions — mostly just punctuation or small style nits, but otherwise this LGTM! 💜

src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
Princesseuh and others added 5 commits June 27, 2022 08:26
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks Erika. Couple of more suggestions based on Sarah’s feedback and then you should be good to merge!

src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
src/pages/en/editor-setup.md Outdated Show resolved Hide resolved
Princesseuh and others added 3 commits June 27, 2022 12:06
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Prettier plugin to Editor Setup page
3 participants