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 readme for Netlify and NextJS #12041

Merged
merged 4 commits into from
Mar 26, 2024
Merged

Update readme for Netlify and NextJS #12041

merged 4 commits into from
Mar 26, 2024

Conversation

corwintines
Copy link
Member

@corwintines corwintines commented Jan 29, 2024

Description

  • Updates readme information from Gatsby to NextJS information

Fixes: #12068

Copy link

netlify bot commented Jan 29, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit 1742367
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/6601da0d72a5e60008992971
😎 Deploy Preview https://deploy-preview-12041--ethereumorg.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.

@corwintines corwintines changed the title Update readme for netlify Update readme for Netlify and NextJS Jan 29, 2024
Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

Overall looks good! Just a comment about the Netlify preview screenshot image

README.md Outdated
```

- Open this directory in your favorite text editor / IDE, and see your changes live by visiting `localhost:8000` from your browser
- Open this directory in your favorite text editor / IDE, and see your changes live by visiting `localhost:3000` from your browser
- Pro Tip:
- Explore scripts within `package.json` for more build options
- Get **faster** local builds by building only one language. E.g. in your `.env` file, set `BUILD_LOCALES=en` to build the content only in English
Copy link
Member

Choose a reason for hiding this comment

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

Not a blocker for this PR, but this tip is less helpful now that we use Next.js... it's handy if you're building the site, but doesn't matter for yarn dev since pages are built on-demand.

Copy link
Member

Choose a reason for hiding this comment

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

Agree. I found it informative though. Perhaps we could clarify that it is faster for production builds (yarn build).

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed the wording here to be production

README.md Outdated
- Gatsby Cloud (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.:
![Gatsby Cloud deploy preview](./GC-preview-deploy.png)
- _Confirm your GC preview deploy looks & functions as expected_
- Netlify (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.:
Copy link
Member

Choose a reason for hiding this comment

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

...accessible preview URL, e.g.:

@corwintines Did we mean to remove the image here? If so, we should remove the , e.g.: from the end of this line

Copy link
Member

Choose a reason for hiding this comment

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

I think we should add an image here. Probably this:
image

Copy link
Member Author

Choose a reason for hiding this comment

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

Added this image, thanks @pettinarip!

Copy link
Member

@pettinarip pettinarip left a comment

Choose a reason for hiding this comment

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

Nicely done @corwintines left a couple of comments.

README.md Outdated Show resolved Hide resolved
README.md Outdated
- Gatsby Cloud (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.:
![Gatsby Cloud deploy preview](./GC-preview-deploy.png)
- _Confirm your GC preview deploy looks & functions as expected_
- Netlify (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.:
Copy link
Member

Choose a reason for hiding this comment

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

I think we should add an image here. Probably this:
image

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

lgtm! Thanks @corwintines!

@wackerow wackerow merged commit 6c9432e into dev Mar 26, 2024
6 checks passed
@wackerow wackerow deleted the updateReadme branch March 26, 2024 01:13
This was referenced Mar 26, 2024
@wackerow wackerow added documentation 📖 Change or add documentation and removed documentation 📖 labels Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Change or add documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Images in README.md File
3 participants