Clarify how the Pages git-integration can be added to a Next.js app #12707
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dario-piotrowicz
requested review from
GregBrimble,
WalshyDev and
a team
as code owners
dario-piotrowicz
force-pushed
the
nextjs-clarify-git-integration
branch
from
1b848e0
to
1e364bd
Compare
|
|
||
| - install necessary dependencies, including the [Wrangler](/workers/wrangler/install-and-update/#check-your-wrangler-version) CLI and the `@cloudflare/next-on-pages` adapter | ||
| - ask you a series of setup questions | ||
| - allow you to setup a new git repo |
There was a problem hiding this comment.
No need to mention the new git repo part here as it can confuse people and it also doesn't really add much to the guide
| @@ -9,20 +9,21 @@ title: Deploy a Next.js site | |||
|
|
|||
| This guide will instruct you how to deploy a full-stack Next.js project which uses the [Edge Runtime](https://nextjs.org/docs/app/api-reference/edge). | |||
|
|
|||
| ## Create a new project using the `create-cloudflare` CLI (C3) | |||
| ## Create a new project using C3 | |||
There was a problem hiding this comment.
I just find it nicer shortened (as the longer version was getting wrapped onto multiple lines), but I can revert this if we prefer the longer version 🙂
|
|
||
| Besides manual deployments, you can make use of the [Pages git integration](/pages/configuration/git-integration), which allows you to connect a GitHub repository to your Pages application and have the application automatically built and deployed after each new commit is pushed to it. | ||
|
|
||
| This requires a basic understanding of [Git](https://git-scm.com/). If you are new to Git, refer to this [summarized Git handbook](https://guides.github.com/introduction/git-handbook/) on how to set up Git on your local machine. |
There was a problem hiding this comment.
unfortunately there's a bunch of stuff here that I copy-pasted from existing partials, the issue is that things are different enough for the partials not to be reusable here 😢
dario-piotrowicz
force-pushed
the
nextjs-clarify-git-integration
branch
from
1e364bd
to
ed2c590
Compare
IgorMinar
reviewed
Jan 30, 2024
There was a problem hiding this comment.
is this a great improvement! @deadlypants1973 can you please take a look as well?
Co-authored-by: Igor Minar <i@igor.dev>
jculvey
reviewed
Feb 7, 2024
Co-authored-by: James Culveyhouse <jculveyhouse@gmail.com>
jculvey
reviewed
Feb 7, 2024
Co-authored-by: James Culveyhouse <jculveyhouse@gmail.com>
|
Closing this PR in favour of #12901 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt on clarifying how the git-integration can be added to a Next.js app created in the guide (since the guide mostly relies on C3 which just manually deploys the app for users).
I testing the water with this PR, If this change is beneficial I can apply the same sort of change to all the other Pages guides which use C3 which, I believe make the whole manual vs git-integration deployment topic very unclear
Nuxt for example
For example see the Nuxt guide: https://developers.cloudflare.com/pages/framework-guides/deploy-a-nuxt-site/
It asks people to create a GitHub repo without knowing it they plan to use the git-integration, then it tells them how to deploy using C3 or how to deploy via the dashboard, all without never saying that the git integration can only happen if they haven't yet deployed via C3
It does feels quite confusing/unclear to me 😕
cc. @deadlypants1973