Update test setup docs and few typo fixes (#1150)

## Description

Found a few misses in the docs regarding test env setup.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
This commit is contained in:
Abin Simon 2022-10-14 04:42:16 +05:30 committed by GitHub
parent 1c5f3d631d
commit a6f4f65dba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 13 deletions

View File

@ -29,11 +29,11 @@ The following steps outline a simplified procedure for creating an Azure Ad appl
1. **Configure required permissions**
Select **App Permission** from the app management panel.
Select **API Permissions** from the app management panel.
<img src="/img/m365app_permissions.png" className="guideImages"/>
The required permissions are as follows:
Select the following permissions from **Microsoft API &#8594; Microsoft Graph &#8594; Application Permissions**:
<!-- vale Microsoft.Spacing = NO -->
| API / Permissions Name | Type | Description
@ -60,8 +60,8 @@ To extract the tenant and client ID, select Overview from the app management pan
environment variables.
```bash
export AZURE_TENANT_ID=<Directory (tenent) ID for configured app>
export AZURE_CLIENT_ID=<Application (client) ID for configured app>
export TENANT_ID=<Directory (tenent) ID for configured app>
export CLIENT_ID=<Application (client) ID for configured app>
```
<img src="/img/m365app_ids.png" className="guideImages"/>
@ -75,7 +75,7 @@ Click **New Client Secret** and follow the instructions to create a secret. Afte
value right away because it won't be available later and export it as an environment variable.
```bash
export AZURE_CLIENT_SECRET=<client secret value>
export CLIENT_SECRET=<client secret value>
```
<img src="/img/m365app_secret.png" className="guideImages"/>

View File

@ -2,10 +2,10 @@
## Prerequisites
- Set `CORSO_PASSWORD` environment variable
- Set `CORSO_PASSPHRASE` environment variable
```bash
export CORSO_PASSWORD=<some password>
export CORSO_PASSPHRASE=<some password>
```
- Set AWS credential (needed for tests that use S3) environment variables
@ -30,6 +30,8 @@
- Set M365 Credentials environment variables
> You can find more information on how to get these values in [configuration docs](/configuration/m365_access).
```bash
export TENANT_ID=<tenant>
export CLIENT_ID=<id>

View File

@ -36,9 +36,9 @@ To create the environment variables file, you can run the following.
# create an env vars file
$ cat <<EOF ~/.corso/corso.env
CORSO_PASSPHRASE
AZURE_TENANT_ID
AZURE_CLIENT_ID
AZURE_CLIENT_SECRET
TENANT_ID
CLIENT_ID
CLIENT_SECRET
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_SESSION_TOKEN

View File

@ -17,7 +17,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="tutorial">
Docusaurus Tutorial - 5min
Corso Tutorial - 5min
</Link>
</div>
</div>