From 6468b356a60d75441c1dec7859d7f1829814527a Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Tue, 29 Nov 2022 19:38:41 -0500 Subject: [PATCH] Add Django, Rails integration instructions to docs and move cli login to overview page --- docs/cli/overview.mdx | 6 ++++++ docs/cli/usage.mdx | 16 +++++----------- docs/integrations/frameworks/django.mdx | 18 +++++++++++++++++- .../frameworks/{fibre.mdx => fiber.mdx} | 2 +- docs/integrations/frameworks/nextjs.mdx | 2 +- docs/integrations/frameworks/rails.mdx | 18 +++++++++++++++++- docs/integrations/overview.mdx | 6 +++--- docs/mint.json | 2 +- 8 files changed, 51 insertions(+), 19 deletions(-) rename docs/integrations/frameworks/{fibre.mdx => fiber.mdx} (59%) diff --git a/docs/cli/overview.mdx b/docs/cli/overview.mdx index bbe86d379..8411b8e75 100644 --- a/docs/cli/overview.mdx +++ b/docs/cli/overview.mdx @@ -95,3 +95,9 @@ The Infisical CLI provides a way to inject environment variables from the platfo + +## Log in to the Infisical CLI + +```bash +infisical login +``` diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index ea7180068..4237f8154 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -4,12 +4,6 @@ title: "Usage" Prerequisite: [Install the CLI](/cli/overview) -## Log in to the Infisical CLI - -```bash -infisical login -``` - ## Initialize Infisical for your project ```bash @@ -29,11 +23,11 @@ infisical run -- [your application start command] Options you can specify: -| Option | Description | Default value | -| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | -| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | -| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` | -| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | +| Option | Description | Default value | +| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | +| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | +| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` | +| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | ## Examples: diff --git a/docs/integrations/frameworks/django.mdx b/docs/integrations/frameworks/django.mdx index 1835c2e9e..e3378d1b6 100644 --- a/docs/integrations/frameworks/django.mdx +++ b/docs/integrations/frameworks/django.mdx @@ -2,4 +2,20 @@ title: "Django" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Django](https://www.djangoproject.com) project + +```bash +# move to your Django project +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Start your server with environment variables injected + +```bash +infisical run -- python manage.py runserver +``` diff --git a/docs/integrations/frameworks/fibre.mdx b/docs/integrations/frameworks/fiber.mdx similarity index 59% rename from docs/integrations/frameworks/fibre.mdx rename to docs/integrations/frameworks/fiber.mdx index 0d281a5f3..988fe901d 100644 --- a/docs/integrations/frameworks/fibre.mdx +++ b/docs/integrations/frameworks/fiber.mdx @@ -1,5 +1,5 @@ --- -title: "Fibre" +title: "Fiber" --- Coming soon. diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx index 5fa87297d..d5733df52 100644 --- a/docs/integrations/frameworks/nextjs.mdx +++ b/docs/integrations/frameworks/nextjs.mdx @@ -4,7 +4,7 @@ title: "Next.js" Prerequisite: [Install the CLI](/cli/overview) -## Initialize Infisical for your [Next.js](https://nextjs.org) +## Initialize Infisical for your [Next.js](https://nextjs.org) app ```bash # move to your Next.js app diff --git a/docs/integrations/frameworks/rails.mdx b/docs/integrations/frameworks/rails.mdx index 9bb59f920..8e1dcf6ed 100644 --- a/docs/integrations/frameworks/rails.mdx +++ b/docs/integrations/frameworks/rails.mdx @@ -2,4 +2,20 @@ title: "Ruby on Rails" --- -Instructions coming soon. +Prerequisite: [Install the CLI](/cli/overview) + +## Initialize Infisical for your [Rails](https://rubyonrails.org) app + +```bash +# move to your Rails app +cd /path/to/project + +# initialize infisical +infisical init +``` + +## Start your server with environment variables injected + +```bash +infisical run -- bin/rails server +``` diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx index 651f86a6f..17c7a7f72 100644 --- a/docs/integrations/overview.mdx +++ b/docs/integrations/overview.mdx @@ -31,8 +31,8 @@ Missing an integration? Throw in a [request](https://github.com/Infisical/infisi | [Gatsby](/integrations/frameworks/gatsby) | Framework | Available | | [Remix](/integrations/frameworks/remix) | Framework | Available | | [Vite](/integrations/frameworks/vite) | Framework | Available | -| [Fibre](/integrations/frameworks/fibre) | Framework | Coming soon | -| [Django](/integrations/frameworks/django) | Framework | Coming soon | +| [Fiber](/integrations/frameworks/fiber) | Framework | Coming soon | +| [Django](/integrations/frameworks/django) | Framework | Available | | [Flask](/integrations/frameworks/flask) | Framework | Available | | [Laravel](/integrations/frameworks/laravel) | Framework | Coming soon | -| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Coming soon | +| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Available | diff --git a/docs/mint.json b/docs/mint.json index f2f8a7877..7d0317f0e 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -142,7 +142,7 @@ "integrations/frameworks/gatsby", "integrations/frameworks/remix", "integrations/frameworks/vite", - "integrations/frameworks/fibre", + "integrations/frameworks/fiber", "integrations/frameworks/django", "integrations/frameworks/flask", "integrations/frameworks/laravel",