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

[update] ssr adapter astro add instructions #1452

Merged
merged 9 commits into from
Sep 6, 2022
Merged

[update] ssr adapter astro add instructions #1452

merged 9 commits into from
Sep 6, 2022

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Sep 1, 2022

  • New or updated content

Docs currently only show manual instructions for adding SSR adapters. This updates all the (located in Docs repo) pages to first instruct using npx astro add and then offer the current manual instructions (install the package, update astro.config.mjs) as an alternative.

Pages updated: SSR and all the deploy pages. (Integration package READMEs and configuration-reference will need to be updated at withastro/astro.)

NOTE: Current Maintainers discussion needs to be resolved first re: our general move to recommend dependencies over devDependencies because of astro add's behavior. These changes assume that manual installation instructions should NOT show installing as dev dependencies, to be consistent. But, since astro add currently DOES use the dev flag, we want to wait for a resolution before publishing these instructions.

POSSIBLE CHANGES NEEDED: manual instructions might need to have the --save-dev flag added back if we decide these ARE to be installed as devDeps

@netlify
Copy link

netlify bot commented Sep 1, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 2512bbe
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/63173e587c1308000983b7da
😎 Deploy Preview https://deploy-preview-1452--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.

@sarah11918 sarah11918 mentioned this pull request Sep 1, 2022
29 tasks
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.

Thanks for this @sarah11918, I added a small suggestion! I'll hold my "LGTM" till we have an decision about dependencies or devDependencies.

src/pages/en/guides/server-side-rendering.md Outdated Show resolved Hide resolved
@yanthomasdev yanthomasdev added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Sep 1, 2022
@sarah11918 sarah11918 merged commit 9ceb052 into main Sep 6, 2022
@sarah11918 sarah11918 deleted the astro-add-ssr branch September 6, 2022 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants