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

simlify auto-install instructions #867

Merged
merged 17 commits into from
Jul 5, 2022
Merged

Conversation

FredKSchott
Copy link
Member

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

@netlify
Copy link

netlify bot commented Jun 27, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 01dc637
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/62c4a3ed3eda13000889b183
😎 Deploy Preview https://deploy-preview-867--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.

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 for putting this together to accompany the CLI PR @FredKSchott!

I’ve given this a fairly hefty review — hope you don’t mind. I think this basically comes down to who we’re writing for. I personally would be happy following the new version of this guide but the current version of the page was carefully written with a beginner in mind and I’d love to see some of the hand holding that that entails preserved.

Maybe once we have Sarah’s tutorial up we could revisit that — have a detailed, beginner-focused tutorial and slim down this install guide? But until then this page is our opportunity to snag new users and call out helpful features.

Curious to hear what you think!

src/pages/en/install/auto.md Outdated Show resolved Hide resolved
src/pages/en/install/auto.md Show resolved Hide resolved
src/pages/en/install/auto.md Show resolved Hide resolved
src/pages/en/install/auto.md Show resolved Hide resolved
src/pages/en/install/auto.md Outdated Show resolved Hide resolved
src/pages/en/install/auto.md Outdated Show resolved Hide resolved
src/pages/en/install/auto.md Outdated Show resolved Hide resolved
@FredKSchott
Copy link
Member Author

Thanks for the review @delucis! I totally agree with your comment on our goal to write with the beginner in mind, and I think a lot of the removed copy here is because the create-astro tool itself is now more beginner friendly (see the linked PR above for a video explaining how).

@delucis
Copy link
Member

delucis commented Jun 27, 2022

Thanks for taking my comments on board Fred! 💜

I do still worry slightly about framework support being buried — some of Astro’s hype is around its framework support and then it ends up at the bottom of this page and at the bottom of our sidebar, but maybe that’s good: hype to draw folks in, then get them comfortable with .astro components and they may never need React 🤞

I think I’ll hand over to @sarah11918 at this point to get some expert fresh eyes to do a read through and see how it feels with your revisions.

@delucis
Copy link
Member

delucis commented Jun 29, 2022

LGTM! Thanks for the great team work on this one folks.

At some point, I wonder if we will want to revisit having “Install NPM Dependencies” as such a prominent second step given it’s effectively optional if you follow the wizard, but for now I’d say this is looking pretty good!

@sarah11918
Copy link
Member

Fair enough, @delucis ! Good thing docs are never done. ;)

@FredKSchott , Chris and I just fine-tuned some of the recent changes via executive decision on this branch. So, I'm sure you'll want to now look at it with fresh eyes. But we are now LGTM as soon as you're happy with it!

@sarah11918 sarah11918 added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Jul 4, 2022
@sarah11918
Copy link
Member

Just a freshness ping @FredKSchott that Chris and I made a few changes you should check on! We are otherwise happy, though. So when you're happy, it's LGTM from us!

@FredKSchott
Copy link
Member Author

Screen Shot 2022-07-05 at 1 30 17 PM

unknown (1)

Took another pass! Again, my goal here is to avoid repeating things that the wizard already tells you. Because the wizard itself is targeting a beginner audience, then it should be beginner friendly on its own! Said another way: If you need to refer to docs on how to run our beginner friendly wizard, then that problem can't be solved with docs, and needs to be solved by improving the wizard.

@sarah11918 one thing that you've called out here that I really agree with is that the template selector doesn't give much guidance as to which template you should pick. I think that should absolutely be added to create-astro!

@FredKSchott
Copy link
Member Author

Follow up here: withastro/astro#3831

I don't want us to spend too much time going back and forth on this too much more. I'm going to merge as-is, then lets give this some time to collect user feedback and we can revisit if we're still not happy.

In the meantime, if anything still feels difficult or tricky for the user, lets improve create-astro itself! For example, I just fired off withastro/astro#3831 to improve some wording to give better guidance for new users.

@FredKSchott FredKSchott merged commit dc860f9 into main Jul 5, 2022
@FredKSchott FredKSchott deleted the update-auto-install-guide branch July 5, 2022 21:04
yanthomasdev added a commit that referenced this pull request Jul 6, 2022
yanthomasdev added a commit that referenced this pull request Jul 11, 2022
…941)

* Update PT-BR `install` pages based on #867 changes

* Apply suggestion

Co-authored-by: Caio Ferrarezi <[email protected]>

Co-authored-by: Caio Ferrarezi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants