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

docs(cloudflare): various updates, cleanups and fixes #1981

Merged
merged 11 commits into from
Jan 4, 2024

Conversation

dario-piotrowicz
Copy link
Contributor

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

In the cloudflare docs page I've found outdated/incorrect details which I am amending here.

Besides that I am also updating and improving some other few bits.

To see the what the various changes are please look at the commit messages.

`wrangler dev` doesn't require `--local` anymore (and it will be removed
in a future major version) so remove it from the cloudflare docs
the latest version of wrangler (recommended to use) is 3, so in the
"wrangler2" text remove the incorrect '2'

Note: instead of setting the test to "wrangler3" let's set it to
"wrangler" so that this won't need to be updated as there are major
wrangler bumps
- instead of using `yarn` sometimes and `npm` so other times,
consistently use `npm`

- globally installing `wrangler` is not advised (it was once), so
remove such suggestions
Copy link
Contributor

nuxt-studio bot commented Dec 3, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
nitro Edit on Studio β†—οΈŽ View Live Preview 3bbc03b

with:
path: node_modules
key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've removed the caching as it looks like an extra step unrelated to this document
(and I feel that keeping things scoped/minimal/simple makes for a better/more useful yml example here)

Copy link
Member

Choose a reason for hiding this comment

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

New node setup action has built-in caching we can opt-in πŸ‘πŸΌ

@pi0 pi0 merged commit 9348300 into nitrojs:main Jan 4, 2024
4 checks passed
@pi0
Copy link
Member

pi0 commented Jan 4, 2024

Thanks for PR ❀️ (and sorry for delay on merge)

@dario-piotrowicz dario-piotrowicz deleted the cloudflare-docs-cleanups branch January 4, 2024 22:54
@dario-piotrowicz
Copy link
Contributor Author

Thanks for PR ❀️ (and sorry for delay on merge)

No problem at all, it's my pleasure, thanks for the merge πŸ˜„

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants