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

[KV] Wrangler-KV Command Update #16400

Merged
merged 5 commits into from
Sep 5, 2024
Merged

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Aug 22, 2024

Summary

Continuation of the PR from: #15985

TLDR of this current PR:

  1. Centralising Wrangler-KV commands into partials/workers/wrangler-commands/kv.mdx. This is the single source of truth for Wrangler-KV commands.
  2. Referencing the KV commands in the "Commands" page in docs/workers/wrangler/commands.mdx.
  3. Referencing the KV commands in the "Commands" page in docs/kv/kv-commands.mdx.
  4. Previously, there were some small discrepancies in H4s between the two locations found in (2) and (3). This has been unified. Specifically, the content from docs/workers/wrangler/commands.mdx has been used over the other.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun
Copy link
Contributor Author

Oxyjun commented Aug 22, 2024

There is currently one pending issue - when the "source of truth" KV commands are rendered in the list of all Wrangler commands, the table of headings on the RHS fails to register duplicated header names. There are several workarounds for this, but these changes need to be properly discussed with PCX.

Copy link

cloudflare-workers-and-pages bot commented Aug 22, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3f93dc8
Status: ✅  Deploy successful!
Preview URL: https://d09fdaf1.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://kv-jun-wrangler-command-upda.cloudflare-docs-7ou.pages.dev

View logs

@github-actions github-actions bot added size/xl product:kv product:workers Related to Workers product labels Aug 22, 2024
@thomasgauvin
Copy link
Contributor

There is currently one pending issue - when the "source of truth" KV commands are rendered in the list of all Wrangler commands, the table of headings on the RHS fails to register duplicated header names. There are several workarounds for this, but these changes need to be properly discussed with PCX.

I think this has been solved, so good to merge?

src/content/partials/workers/wrangler-commands/kv.mdx Outdated Show resolved Hide resolved
src/content/partials/workers/wrangler-commands/kv.mdx Outdated Show resolved Hide resolved

:::caution

This command requires `--binding` or `--namespace-id`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Currently we write this warning in three different ways along the page:

  • This command requires --binding or --namespace-id.
  • This command requires a --binding or --namespace-id flag.
  • Exactly one of --binding or --namespace-id is required.

Oxyjun and others added 2 commits September 5, 2024 09:35
Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
@Oxyjun Oxyjun merged commit b6d6a1c into production Sep 5, 2024
12 checks passed
@Oxyjun Oxyjun deleted the kv/jun/wrangler-command-update branch September 5, 2024 08:56
elithrar pushed a commit that referenced this pull request Oct 15, 2024
* Updating Wrangler commands related to KV.

* Updating KV-specific wrangler docs. Porting PR.

* Correcting syntax so the partial works.

* Update src/content/partials/workers/wrangler-commands/kv.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update src/content/partials/workers/wrangler-commands/kv.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

---------

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
maheshwarip pushed a commit that referenced this pull request Dec 2, 2024
* Updating Wrangler commands related to KV.

* Updating KV-specific wrangler docs. Porting PR.

* Correcting syntax so the partial works.

* Update src/content/partials/workers/wrangler-commands/kv.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update src/content/partials/workers/wrangler-commands/kv.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

---------

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants