From 150beba4fe6110e142db762f3613c529758a8b7b Mon Sep 17 00:00:00 2001 From: Nick Chen Date: Fri, 23 Aug 2024 13:57:01 -0700 Subject: [PATCH] Update docs for `zup link` --- docs/articles/local-development-services.md | 11 ++++++----- docs/cli/local-development.md | 1 - 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/articles/local-development-services.md b/docs/articles/local-development-services.md index 83cbb831..f8ab5cbc 100644 --- a/docs/articles/local-development-services.md +++ b/docs/articles/local-development-services.md @@ -7,17 +7,18 @@ To use Zuplo services such as API keys and rate limiting locally, you must have a Zuplo account and an existing project. You will be using the connections from your remote gateway. -1. Run `npx zup login` to log into your account in your browser. -2. Run `npx zup link` to bring in relevant information from your Zuplo account - and project. Follow the prompt to select the right environment. -3. At this point, you will see a file called `.env.zuplo` containing some +1. Run `npx zup link` to bring in relevant information from your Zuplo account + and project. Follow the prompt to select the right environment. For local + development, we recommend selecting the development environment. +2. At this point, you will see a file called `.env.zuplo` containing some information about the account, project, and environment that your local gateway is linked to. :::warning As the .env.zuplo file could contain sensitive information, it should not be -committed to your version system. Consider adding .env to your .gitignore file. +committed to your version system. Consider adding .env.zuplo to your .gitignore +file. ::: diff --git a/docs/cli/local-development.md b/docs/cli/local-development.md index e5d22333..c62aa05c 100644 --- a/docs/cli/local-development.md +++ b/docs/cli/local-development.md @@ -10,7 +10,6 @@ Commands: zup dev Runs the zup locally zup editor Starts a local Open API Designer zup link Links information from your Zuplo account to your local machine - zup login Authenticates the user ``` See more examples at [Local Development](../articles/local-development.md).