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] Replace johns-apparel with IANA-reserved domain #4241

Merged
merged 5 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/thirty-glasses-shave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/cli': patch
---

Replace sample domain with IANA-reserved domain for technical documentation
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface themeconsole {
'--port <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface themedelete {
'-a, --show-all'?: ''

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export interface themedev {
'--port <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface themeinfo {
'--password <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface themelist {
'--role <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface themeopen {
'--password <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface themepublish {
'--password <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export interface themepull {
'--path <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export interface themepush {
'-p, --publish'?: ''

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface themerename {
'--password <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface themeshare {
'--path <value>'?: string

/**
* Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
* Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
* @environment SHOPIFY_FLAG_STORE
*/
'-s, --store <value>'?: string
Expand Down
44 changes: 22 additions & 22 deletions docs-shopify.dev/generated/generated_docs_data.json

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1612,8 +1612,8 @@ USAGE

FLAGS
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--port=<value> [default: 9293] Local port to serve authentication service.
Expand Down Expand Up @@ -1643,8 +1643,8 @@ FLAGS
-d, --development Delete your development theme.
-e, --environment=<value> The environment to apply to the current command.
-f, --force Skip confirmation.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value>... Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
Expand Down Expand Up @@ -1684,8 +1684,8 @@ FLAGS
Hot reload only files that match the specified pattern.

-s, --store=<value>
Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com,
https://johns-apparel.myshopify.com).
Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com,
https://example.myshopify.com).

-t, --theme=<value>
Theme ID or name of the remote theme.
Expand Down Expand Up @@ -1778,8 +1778,8 @@ USAGE
FLAGS
-d, --development Retrieve info from your development theme.
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--json Output the theme info as JSON.
--no-color Disable color output.
Expand Down Expand Up @@ -1854,8 +1854,8 @@ USAGE

FLAGS
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--id=<value> Only list theme with the given ID.
--json Output the theme list as JSON.
--name=<value> Only list themes that contain the given name.
Expand Down Expand Up @@ -1883,8 +1883,8 @@ FLAGS
-d, --development Open your development theme.
-e, --environment=<value> The environment to apply to the current command.
-l, --live Open your live (published) theme.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
Expand Down Expand Up @@ -1940,8 +1940,8 @@ USAGE
FLAGS
-e, --environment=<value> The environment to apply to the current command.
-f, --force Skip confirmation.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
Expand Down Expand Up @@ -1977,8 +1977,8 @@ FLAGS
-l, --live Pull theme files from your remote live theme.
-n, --nodelete Runs the pull command without deleting local files.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
-x, --ignore=<value>... Skip downloading the specified files (Multiple flags allowed).
--no-color Disable color output.
Expand Down Expand Up @@ -2012,8 +2012,8 @@ FLAGS
-n, --nodelete Runs the push command without deleting local files.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-p, --publish Publish as the live theme after uploading.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
-u, --unpublished Create a new unpublished theme and push to it.
-x, --ignore=<value>... Skip downloading the specified files (Multiple flags allowed).
Expand Down Expand Up @@ -2073,8 +2073,8 @@ FLAGS
-e, --environment=<value> The environment to apply to the current command.
-l, --live Rename your remote live theme.
-n, --name=<value> The new name for the theme.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
Expand All @@ -2099,8 +2099,8 @@ USAGE

FLAGS
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
(johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--path=<value> The path to your theme directory.
Expand Down
24 changes: 12 additions & 12 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4787,7 +4787,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -4886,7 +4886,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5084,7 +5084,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5176,7 +5176,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5386,7 +5386,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5471,7 +5471,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5595,7 +5595,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5752,7 +5752,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -5930,7 +5930,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -6039,7 +6039,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -6237,7 +6237,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -6336,7 +6336,7 @@
},
"store": {
"char": "s",
"description": "Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).",
"description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
"env": "SHOPIFY_FLAG_STORE",
"hasDynamicHelp": false,
"multiple": false,
Expand Down
Loading