[Docs Site] Add WranglerCommand component #17625
Conversation
KianNH
requested review from
a team,
G4brym,
GregBrimble,
ToriLindsay,
WalshyDev,
crwaters16,
daisyfaithauma,
dario-piotrowicz,
haleycode,
irvinebroque,
kathayl,
kristianfreeman,
marciocloudflare,
maxvp,
mchenco,
mikenomitch,
pedrosousa,
penalosa and
petebacondarwin
as code owners
github-actions
bot
added
product:ai-gateway
github-actions
bot
assigned
GregBrimble,
haleycode,
kristianfreeman and
marciocloudflare
github-actions
bot
assigned
maxvp,
pedrosousa,
WalshyDev,
daisyfaithauma,
G4brym and
kathayl
Deploying cloudflare-docs with
|
| Latest commit: |
a7c4c90
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b0e1e67e.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://kian-pcx-14259.cloudflare-docs-7ou.pages.dev |
|
This is very cool. Who is reviewing? |
|
@bllchmbrs FYI - Here's some work being done do improve Wrangler commands' docs you may want to be aware of. |
| ``` | ||
|
|
||
| ### `delete` | ||
| {/* <WranglerCommand cmd="secret delete" /> */} |
|
Optional positionals are colored differently to required positionals. Is that intentional?
vs.
|
There was a problem hiding this comment.
You've dropped secret delete, at least (I didn't give content the most intense of reviews — Wrangler team are best placed as owners to spot anything awry there).
Regex parsing looks like it was a pain and a half, so kudos on that working and looking as good as it does. But hopefully we can get something more useful from Wrangler in the future. This script is only going to become more brittle as time goes on without it.
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
| It may take up to 1 minute (60 seconds) for a tail to exit sampling mode after adding an option to filter tail messages. | ||
| ::: | ||
|
|
||
| If sampling persists after using options to filter messages, consider using [instant logs](https://developers.cloudflare.com/logs/instant-logs/). |
There was a problem hiding this comment.
| If sampling persists after using options to filter messages, consider using [instant logs](https://developers.cloudflare.com/logs/instant-logs/). | |
| If sampling persists after using options to filter messages, consider using [instant logs](/logs/instant-logs/). |
Issues:
- Style Guide - (cloudflare.LinkChecks-warning) Warning: When referring to another page in our docs, use the full relative link (
/1.1.1.1/check/) instead of the full URL (https://developers.cloudflare.com/1.1.1.1/check/) or a local development link (http://localhost:111/1.1.1.1/check/).
Fix Explanation:
The issue identified is related to the use of a full URL instead of a relative link. According to the style guide, we should use relative links when referring to other pages within the documentation. I've replaced the full URL with a relative path to adhere to this guideline.
12 participants
Summary
Add WranglerCommand components.
There is a
scripts/wrangler-commands-json.tsfile which parses the--helpoutput of each Wrangler command, and creates a JSON file. This is hopefully a short term solution, as Wrangler moves towards providing it's own structured data: cloudflare/workers-sdk#6526The
WranglerCommandcomponent reads from this JSON file.