Restructure docs around new anchors

This commit is contained in:
Tuan Dang
2022-11-27 23:36:50 -05:00
parent 798eb67296
commit 0a9f4ffc4d
11 changed files with 132 additions and 144 deletions

View File

@@ -8,24 +8,7 @@ If you're using a self-hosted installation, follow the [setup](/self-hosting/ove
## Infisical Cloud
**Step 1:** Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to head to the signup sequence.
![title](../../images/landing-page.png)
**Step 2:** Fill out the signup sequence.
![signup start](../../images/signup-box.png)
![signup one-time password](../../images/signup-otp.png)
![signup complete account](../../images/signup-complete-account.png)
You'll be prompted to fill out some required fields to set up your account.
| Field | Description |
| ---------- | --------------------------- |
| Email | Enter a valid email address |
| First name | Your first name |
| Last name | Your last name |
| Password | Password |
Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to complete the signup sequence.
Once you've done that, you'll be taken to the dashboard where we've populated some default environment variables for demonstration.

View File

@@ -2,12 +2,10 @@
title: "Integrations"
---
We’re still early with integrations but you’ll be able to sync environment variables across your entire infrastructure from local development to CI/CD and production.
Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production.
We're still early with integrations, but expect more soon.
![integrations](../../images/project-integrations.png)
Check out integrations:
- [Heroku](/integrations/heroku)
- [Docker](/integrations/docker)
- [Docker Compose](/integrations/docker-compose)
Check out our [integrations](/integrations/overview).

View File

@@ -2,15 +2,12 @@
title: "Organization"
---
By default, Infisical creates an organization under your name such as "John's Organization." To make changes and add members to your organization, head to your organization settings.
An organization houses projects and members.
![organization name selected](../../images/dashboard-name-selected.png)
By default, Infisical creates an organization under your name. You can manage your organization in your organization settings.
![organization name modal open](../../images/dashboard-name-modal-organization.png)
![organization page](../../images/organization.png)
Feel free to change the name of your organization.
![organization name modal open](../../images/organization.png)
## Members
@@ -19,9 +16,12 @@ Members of an organization can create and add other members to projects within t
To add a member to your organization, scroll down to the "Organization Members" section and invite the member via email. They'll receive an email to confirm their organization invitation. If the member is an existing user on the platform, they will be automatically added to the organization.
![organization members](../../images/organization-members.png)
![organization members add](../../images/organization-members-add.png)
Note that access to projects must be provisioned to new members after they've accepted their invitation, and they will not be added to any projects by default.
<Note>
Note that access to projects must be provisioned to new members after they've
accepted their organization invitation, and they will not be added to any
projects by default.
</Note>
## Incident contacts
@@ -30,4 +30,3 @@ Incident contacts of an organization are alerted if anything abnormal is detecte
To add an incident contact to your organization, scroll down to the "Incident Contacts" section and add their email.
![organization incident contacts](../../images/organization-ic.png)
![organization incident contacts add](../../images/organization-ic-add.png)

View File

@@ -2,7 +2,7 @@
title: "Project"
---
A project houses environment variables for an application or service.
A project houses environment variables for an application.
## Dashboard
@@ -33,20 +33,14 @@ Every environment variable is classified as either personal or shared.
You can toggle the classification of an environment variable by pressing on its settings:
![project variable toggle](../../images/project-envar-toggle.png)
![project variable toggle open](../../images/project-envar-toggle-open.png)
![project variable toggle moved](../../images/project-envar-toggle-moved.png)
### Search
You can search for any environment variable by its key.
![project search](../../images/project-search.png)
![project search typed](../../images/project-search-typed.png)
### Sort
You can sort environment variables alphabetically by their keys.
@@ -59,8 +53,6 @@ You can hide or un-hide the values of your environment variables. By default, th
![project hide](../../images/project-hide.png)
![project unhide](../../images/project-hide.png)
### Download as .env
You can download your environment variables back in a .env file.

View File

@@ -2,20 +2,15 @@
title: "Infisical Token"
---
An Infisical Token is needed to authenticate the CLI when there isn't an easy way to manually type in your login credentials to sync environment variables to your applications.
An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials.
It grants read-only access to a particular environment and project for a specified amount of time.
It's useful for the [Docker](/integrations/docker) and [Docker Compose](/integrations/docker-compose) integrations.
This is useful in the following contexts:
- [Docker](/integrations/docker)/[Docker-Compose](/integrations/docker-compose) integration: An Infisical Token can be passed to a Docker container as an environment variable for the CLI to authenticate and pull its corresponding secrets.
## Generate an Infisical Token
It's possible to generate an Infisical token in the settings of a project.
It's possible to generate the token in the settings of a project.
![token add](../../images/project-token-add.png)
![token name](../../images/project-token-name.png)
![token added](../../images/project-token-added.png)
<Note>
The token grants read-only access to a particular environment and project for
a specified amount of time.
</Note>