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

streamlined install plus develop and build pages #10060

Merged
merged 9 commits into from
Nov 21, 2024

Conversation

sarah11918
Copy link
Member

Description (required)

Attempts to make a sleeker "getting started" path!

Notably:

  • trims down the current "install and setup" page to just installation instructions
  • combines installation instructions for examples/templates in basic CLI wizard instructions
  • takes the content that was cut to form a "develop and build" page for those who want more guidance on e.g. starting the dev server, building and previewing

For review:

  • the PackageManagerTabs now show multiple commands, so I've separated out the basic one (for copy paste reasons) from the others that can't be used copy paste anyway. Are we cool with this?

  • I believe Erika is adding an --add flag for the command to run astro add with integrations upon project creation. Will happily add this to the blocks too!

  • did not rename install-and-setup.mdx and therefore no redirect at this time. But we could rename to e.g. installation.mdx and therefore would need a redirect.

Note:

  • did NOT add a nav.ts entry because I expect the new sidebar to be merged before this PR, so we won't need it! Will update sidebar entries after merging.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 2dd609b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/673f807d62978e000887be4c
😎 Deploy Preview https://deploy-preview-10060--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 configuration.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Nov 19, 2024

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

File Note
en/develop-and-build.mdx Localization added, will be marked as complete.
en/guides/migrate-to-astro/from-docusaurus.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-eleventy.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-gatsby.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-gitbook.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-gridsome.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-hugo.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-jekyll.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-nextjs.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-nuxtjs.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-pelican.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-sveltekit.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-vuepress.mdx Source changed, localizations will be marked as outdated.
en/guides/migrate-to-astro/from-wordpress.mdx Source changed, localizations will be marked as outdated.
en/install-and-setup.mdx Source changed, localizations will be marked as outdated.
en/recipes/bun.mdx Source changed, localizations will be marked as outdated.
it/recipes/bun.mdx Localization changed, will be marked as complete.
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.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Nov 19, 2024
@sarah11918 sarah11918 changed the title streamlined install plus develop and build pages [i18nIgnore] streamlined install plus develop and build pages Nov 19, 2024
@sarah11918 sarah11918 added the information architecture reorganizes content on the site label Nov 19, 2024
@sarah11918 sarah11918 changed the title [i18nIgnore] streamlined install plus develop and build pages streamlined install plus develop and build pages Nov 19, 2024
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.

combines installation instructions for examples/templates in basic CLI wizard instructions

I think I’m missing a “why” here. I find it a bit confusing to combine these in a step by step guide: if scanning quickly, do I also need to run these? if I already ran the first command and now realise wanted one of the other ones, what do I do?

takes the content that was cut to form a "develop and build" page for those who want more guidance on e.g. starting the dev server, building and previewing

I like this page!

I believe Erika is adding an --add flag

Certainly wouldn’t add more to these steps. If anything that tells me to have subsections below for “Use a custom template”, “Add integrations” etc.

@sarah11918
Copy link
Member Author

sarah11918 commented Nov 19, 2024

I think I’m missing a “why” here.

So some of my thinking here:

  • Installing from a theme/template is still installing from the CLI, so it didn't seem like it belonged under a different heading (could keep the old section, just make it a subheading though!)
  • If we think people will reasonably install with flags (--template, --add) then this "catches" people right when they're about to install, not after they've already run create astro without any flags.

We could have a section for installation flags for customizing installation. (add integrations, use a particular theme/starter example)

Copy link
Member

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

LGTM! Just a nit regarding the "Install dependencies" step. But I guess pnpm add astro works too.

src/content/docs/en/install-and-setup.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install-and-setup.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install-and-setup.mdx Outdated Show resolved Hide resolved
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

A few nits here, but overall LGTM

src/content/docs/en/develop-and-build.mdx Outdated Show resolved Hide resolved
src/content/docs/en/develop-and-build.mdx Outdated Show resolved Hide resolved
src/content/docs/en/develop-and-build.mdx Outdated Show resolved Hide resolved
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@sarah11918 sarah11918 merged commit 5cb38ee into 5.0.0-beta Nov 21, 2024
10 checks passed
@sarah11918 sarah11918 deleted the develop-and-build branch November 21, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0.0-beta i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! information architecture reorganizes content on the site
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants