From 533036cba1b0c54a99ca43f88869604c036f47bc Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Thu, 13 Feb 2025 17:07:27 -0700 Subject: [PATCH 1/2] docs: clarify login url usage --- docs/repo-docs/reference/link.mdx | 12 ++++++++++-- docs/repo-docs/reference/login.mdx | 2 +- .../reference/system-environment-variables.mdx | 3 ++- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/repo-docs/reference/link.mdx b/docs/repo-docs/reference/link.mdx index a71997207f18e..a609c6e146c5e 100644 --- a/docs/repo-docs/reference/link.mdx +++ b/docs/repo-docs/reference/link.mdx @@ -13,14 +13,22 @@ The selected owner (either a user or an organization) will be able to share [cac Specifies the URL of your Remote Cache provider. +```bash title="Terminal" +turbo link --api=https://example.com +``` + ### `--yes` Answer yes to all prompts +```bash title="Terminal" +turbo link --yes +``` + ### `--scope ` -The scope, i.e. Vercel team, to which you are linking +The scope to which you are linking. For example, when using Vercel, this is your Vercel team's slug. ```bash title="Terminal" -turbo link --api https://acme.com +turbo link --scope=your-team ``` diff --git a/docs/repo-docs/reference/login.mdx b/docs/repo-docs/reference/login.mdx index 788257ca6bd82..9ee3cbbfabcd0 100644 --- a/docs/repo-docs/reference/login.mdx +++ b/docs/repo-docs/reference/login.mdx @@ -19,7 +19,7 @@ turbo login --api=https://acme.com/api ### --login \ -Set the URL for login requests. This is only required for platforms with robust login features. +Set the URL for login requests. This is only required for platforms implementing multi-tenancy. ```bash title="Terminal" turbo login --login=https://acme.com diff --git a/docs/repo-docs/reference/system-environment-variables.mdx b/docs/repo-docs/reference/system-environment-variables.mdx index dc4ceeb3760b8..c0e4b5137864d 100644 --- a/docs/repo-docs/reference/system-environment-variables.mdx +++ b/docs/repo-docs/reference/system-environment-variables.mdx @@ -144,7 +144,8 @@ System environment variables are always overridden by flag values provided direc Set the URL used to log in to{' '} - Remote Cache. + Remote Cache. Only + needed for platforms with multi-tenancy. From 6af40d57cc8ceafdf5cba170c49e82737ae94418 Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Fri, 14 Feb 2025 08:21:20 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- docs/repo-docs/reference/login.mdx | 2 +- docs/repo-docs/reference/system-environment-variables.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/repo-docs/reference/login.mdx b/docs/repo-docs/reference/login.mdx index 9ee3cbbfabcd0..4651b16425bd2 100644 --- a/docs/repo-docs/reference/login.mdx +++ b/docs/repo-docs/reference/login.mdx @@ -19,7 +19,7 @@ turbo login --api=https://acme.com/api ### --login \ -Set the URL for login requests. This is only required for platforms implementing multi-tenancy. +Set the URL for login requests that should dynamically generate tokens. ```bash title="Terminal" turbo login --login=https://acme.com diff --git a/docs/repo-docs/reference/system-environment-variables.mdx b/docs/repo-docs/reference/system-environment-variables.mdx index c0e4b5137864d..f1e95d25f00ec 100644 --- a/docs/repo-docs/reference/system-environment-variables.mdx +++ b/docs/repo-docs/reference/system-environment-variables.mdx @@ -145,7 +145,7 @@ System environment variables are always overridden by flag values provided direc Set the URL used to log in to{' '} Remote Cache. Only - needed for platforms with multi-tenancy. + needed for self-hosted Remote Caches that implement an endpoint that dynamically creates tokens.