From 75f550caf2443ef4a7324dd8e7f556438ad616c9 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 20:38:58 +0300 Subject: [PATCH] Finish documentation quickstarts update --- docs/getting-started/introduction.mdx | 66 +++++++++++---- docs/getting-started/introduction2.mdx | 81 ------------------- docs/getting-started/quickstarts/cli.mdx | 35 ++++---- docs/getting-started/quickstarts/docker.mdx | 7 +- .../quickstarts/kubernetes.mdx | 2 +- docs/getting-started/quickstarts/overview.mdx | 41 ---------- docs/getting-started/quickstarts/platform.mdx | 2 +- docs/mint.json | 17 +--- 8 files changed, 75 insertions(+), 176 deletions(-) delete mode 100644 docs/getting-started/introduction2.mdx delete mode 100644 docs/getting-started/quickstarts/overview.mdx diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx index d8f37bddb..a8b3b7c27 100644 --- a/docs/getting-started/introduction.mdx +++ b/docs/getting-started/introduction.mdx @@ -2,40 +2,74 @@ title: "Introduction" --- -Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync secrets like API keys, database credentials, and environment variables. +Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync their environment variables. Start syncing environment variables with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself. +## Learn about Infisical + + + Store secrets like API keys, database credentials, environment variables with Infisical + + +## Integrate with Infisical + - Learn about Infisical and how to fetch secrets in minutes + Fetch secrets with any programming language on demand - - Install the CLI to inject secrets into apps and infra. + + Inject secrets into any application process/environment - - Install an SDK into your app to fetch secrets. + + Inject secrets into Docker containers - Learn how to configure and deploy Infisical. + Fetch and save secrets as native Kubernetes secrets +## Resources + + + Learn how to configure and deploy Infisical. + + + + Explore integrations for GitHub, Vercel, Netlify, and more. + + - Explore integrations for Docker, AWS, Heroku, etc. + Explore integrations for Next.js, Express, Django, and more. + diff --git a/docs/getting-started/introduction2.mdx b/docs/getting-started/introduction2.mdx deleted file mode 100644 index 4835f4b61..000000000 --- a/docs/getting-started/introduction2.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Introduction" ---- - -Infisical is an [open-source](https://opensource.com/resources/what-open-source), [end-to-end encrypted](https://en.wikipedia.org/wiki/End-to-end_encryption) secret management platform that enables teams to easily manage and sync their environment variables. - -Start syncing environment variables with [Infisical Cloud](https://app.infisical.com) or learn how to [host Infisical](/self-hosting/overview) yourself. - -## Learn about Infisical - - - Store secrets like API keys, database credentials, environment variables with Infisical - - -## Integrate with Infisical - - - - Fetch secrets for any programming language on demand - - - Inject secrets into any application process/environment - - - Inject secrets into Docker containers - - - Fetch and save secrets as native Kubernetes secrets - - - -## Resources - - - - Tour Infisical in a few minutes - - - Install the CLI to inject secrets into apps and infra. - - - Install an SDK into your app to fetch secrets. - - - Learn how to configure and deploy Infisical. - - - - - Explore integrations for Docker, AWS, Heroku, etc. - diff --git a/docs/getting-started/quickstarts/cli.mdx b/docs/getting-started/quickstarts/cli.mdx index 37b8d3332..0d567514f 100644 --- a/docs/getting-started/quickstarts/cli.mdx +++ b/docs/getting-started/quickstarts/cli.mdx @@ -2,7 +2,9 @@ title: "CLI" --- -The Infisical CLI can be used to inject secrets for local development, CI/CD needs and Docker image as environment variables. +The Infisical CLI can be used to inject secrets into any framework like Next.js, Express, Django and more in local development. + +It can also be used to expose secrets from Infisical as environment variables in CI/CD pipelines and [Docker containers](/getting-started/quickstarts/docker) Prerequisites: @@ -108,28 +110,19 @@ $ infisical init ## Start your app with environment variables injected ```console -$ infisical run -- [your application start command] +$ infisical run -- ``` -Your app should now be running with the secrets from Infisical injected as environment variables. To see view all possible commands for the CLI, visit the commands tab on the sidebar. +## Example Start Commands -CLI framework resources: +```console +$ infisical run -- npm run dev +$ infisical run -- flask run +$ infisical run -- ./your_bash_script.sh +``` -- [Express/Koa/Fastify](/integrations/frameworks/express) -- [NestJS](/integrations/frameworks/nestjs) -- [Fiber](/integrations/frameworks/fiber) -- [Django](/integrations/frameworks/django) -- [Flask](/integrations/frameworks/flask) -- [Laravel](/integrations/frameworks/laravel) -- [Ruby on Rails](/integrations/frameworks/rails) -- [React](/integrations/frameworks/react) -- [Vue](/integrations/frameworks/vue) -- [Next.js](/integrations/frameworks/nextjs) -- [SvelteKit](/integrations/frameworks/sveltekit) -- [Nuxt](/integrations/frameworks/nuxt) -- [Gatsby](/integrations/frameworks/gatsby) -- [Remix](/integrations/frameworks/remix) -- [Vite](/integrations/frameworks/vite) -- [Fiber](/integrations/frameworks/fiber) +Your app should now be running with the secrets from Infisical injected as environment variables. -Not seeing a framework? Throw in a [request](https://github.com/Infisical/infisical/issues). \ No newline at end of file +Resources: + +- [Documentation for the CLI](/cli/overview) \ No newline at end of file diff --git a/docs/getting-started/quickstarts/docker.mdx b/docs/getting-started/quickstarts/docker.mdx index e6b32f3aa..b9831b296 100644 --- a/docs/getting-started/quickstarts/docker.mdx +++ b/docs/getting-started/quickstarts/docker.mdx @@ -177,4 +177,9 @@ Prerequisites: Your containers should now be running with the secrets from Infisical available inside as environment variables. - \ No newline at end of file + + +Resources: + +- [Documentation for Docker](/integrations/platforms/docker) +- [Documentation for Docker Compose](/integrations/platforms/docker-compose) \ No newline at end of file diff --git a/docs/getting-started/quickstarts/kubernetes.mdx b/docs/getting-started/quickstarts/kubernetes.mdx index 24d324bbc..7865db41b 100644 --- a/docs/getting-started/quickstarts/kubernetes.mdx +++ b/docs/getting-started/quickstarts/kubernetes.mdx @@ -3,7 +3,7 @@ title: "Kubernetes" --- The Infisical Secrets Operator fetches secrets from Infisical and saves them as Kubernetes secrets using the custom `InfisicalSecret` resource to define authentication and storage methods. -The operator updates secrets continuously and can reloads dependent deployments automatically on secret changes. +The operator updates secrets continuously and can reload dependent deployments automatically on secret changes. Prerequisites: diff --git a/docs/getting-started/quickstarts/overview.mdx b/docs/getting-started/quickstarts/overview.mdx deleted file mode 100644 index 2641f1199..000000000 --- a/docs/getting-started/quickstarts/overview.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Overview" ---- - -### Learn about Infisical - - - Store secrets like API keys, database credentials, environment variables with Infisical - - -### Integrate with Infisical - - - - Fetch secrets for any programming language on demand - - - Inject secrets into any application process/environment - - - Inject secrets into Docker containers - - - Fetch and save secrets as native Kubernetes secrets - - \ No newline at end of file diff --git a/docs/getting-started/quickstarts/platform.mdx b/docs/getting-started/quickstarts/platform.mdx index bc60f7cf0..b6b834acc 100644 --- a/docs/getting-started/quickstarts/platform.mdx +++ b/docs/getting-started/quickstarts/platform.mdx @@ -8,7 +8,7 @@ This quickstart provides an overview of the functionalities offered by Infisical ## Projects -Projects hold secrets for applications, which are further organized into environments such as dev, testing and prod. +Projects hold secrets for applications, which are further organized into environments such as development, testing and production. ### Secrets Overview diff --git a/docs/mint.json b/docs/mint.json index 6986e2499..05ee74159 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -79,20 +79,17 @@ { "group": "Overview", "pages": [ - "getting-started/introduction", - "getting-started/introduction2", { - "group": "Quickstarts", + "group": "Getting Started", "pages": [ - "getting-started/quickstarts/overview", + "getting-started/introduction", "getting-started/quickstarts/platform", "getting-started/quickstarts/sdks", "getting-started/quickstarts/cli", "getting-started/quickstarts/docker", "getting-started/quickstarts/kubernetes" ] - }, - "getting-started/features" + } ] }, { @@ -189,13 +186,6 @@ "integrations/platforms/pm2" ] }, - { - "group": "Deployment options", - "pages": [ - "self-hosting/deployments/linux", - "self-hosting/deployments/kubernetes" - ] - }, { "group": "Overview", "pages": [ @@ -300,7 +290,6 @@ ] } ], - "backgroundImage": "/images/background.png", "integrations": { "intercom": "hsg644ru" }