Merge pull request #347 from kirmar/docs/update-setup-instructions

docs: Update setup instructions

Main updates:
* Focus on v2 API keys with updated links
* Note settings for v1 API key (currently required for automated tests)
* Use existing `make` commands where possible
* Remove references to unused environment variables (`TEST_CACHE_DEFAULT`, `TEST_CACHE_WITH_PROFILE`, `TEST_PROFILE`) and nonexistent test file (`configure_profile_test`)

Author: kirmar

CONTRIBUTING.ja.md

@@ -1,22 +1,26 @@
 ## ビルド
 
 ```
-cargo build
+make build
 ```
 
-## テスト
+## Manual Testing
 
 `~/.momento/credentials` と `~/.momento/config` が以下のデータを含み、存在している事をご確認ください。
 
 `~/.momento/credentials`
 
 ```
 [default]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 [YOUR_TEST_PROFILE]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 ```
 
+- If you prefer, create a legacy API key instead (as for [automated testing](#automated-testing)), then set a `token` instead of `api_key_v2`/`endpoint`.
+
 `~/.momento/config`
 
 ```
@@ -28,25 +32,30 @@ cache=<YOUR_TEST_CACHE_WITH_PROFILE>
 ttl=700
 ```
 
-```
-export TEST_CACHE_DEFAULT=<YOUR_TEST_CACHE_DEFAULT>
-export TEST_CACHE_WITH_PROFILE=<YOUR_TEST_CACHE_WITH_PROFILE>
-export TEST_PROFILE=<YOUR_TEST_PROFILE>
-./run_test_sequentially.sh
-cargo clippy --all-targets --all-features -- -D warnings
+Follow the [README](./README.md#use-cli), using `./target/debug/momento` instead of `momento`, for example:
+
+```bash
+./target/debug/momento cache create example-cache
 ```
 
-<br>
+## Automated Testing
 
-:warning: `cargo test --test configure_profiles_test`を実行する上での注意事項
+For the automated tests, a [legacy API key](https://console.gomomento.com/api-keys) is required with the following settings:
+- **Type of key**: Super User Key
+- **Expiration**: highly recommended (Legacy keys do not support revocation.)
 
+```bash
+read -s -p "API key: " TEST_AUTH_TOKEN
+# Paste your API key. (Note: You will not be able to see it in the shell.)
+export TEST_AUTH_TOKEN
+make test
 ```
-export TEST_AUTH_TOKEN=<YOUR_TEST_AUTH_TOKEN>
-cargo test --test configure_profile_test
-```
 
-- もし credentials と config ファイルがすでにローカル環境に存在する場合、`cargo test --test configure_profiles_test`を実行する事により`TEST_AUTH_TOKEN_DEFAULT`で指定されたトークンがご自身の`default`プロファイルで指定されたトークン値を上書きします。
-- `TEST_CACHE_DEFAULT`の値とご自身の`default`プロファルの`cache`値が同じである事、またその`cache`がすでに存在する事が必須条件です。しかし、このテストの実行が成功した場合、その`cache`は削除されます。
+### Formatting
+
+```bash
+make lint
+```
 
 ## デプロイ
 

CONTRIBUTING.md

@@ -1,22 +1,26 @@
 ### Building
 
 ```
-cargo build
+make build
 ```
 
-### Testing
+### Manual Testing
 
-Make sure you have `~/.momento/credentials` and `~/.momento/config` files with the following data.
+Make sure you have `~/.momento/credentials` and `~/.momento/config` files with your [API key(s)](https://console.gomomento.com/keys), [endpoint URL(s)](https://docs.momentohq.com/platform/regions), and [cache name(s)](https://console.gomomento.com/caches).
 
 `~/.momento/credentials`
 
 ```
 [default]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 [YOUR_TEST_PROFILE]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 ```
 
+- If you prefer, create a legacy API key instead (as for [automated testing](#automated-testing)), then set a `token` instead of `api_key_v2`/`endpoint`.
+
 `~/.momento/config`
 
 ```
@@ -28,25 +32,30 @@ cache=<YOUR_TEST_CACHE_WITH_PROFILE>
 ttl=700
 ```
 
-```
-export TEST_CACHE_DEFAULT=<YOUR_TEST_CACHE_DEFAULT>
-export TEST_CACHE_WITH_PROFILE=<YOUR_TEST_CACHE_WITH_PROFILE>
-export TEST_PROFILE=<YOUR_TEST_PROFILE>
-./run_test_sequentially.sh
-cargo clippy --all-targets --all-features -- -D warnings
+Follow the [README](./README.md#use-cli), using `./target/debug/momento` instead of `momento`, for example:
+
+```bash
+./target/debug/momento cache create example-cache
 ```
 
-<br>
+### Automated Testing
 
-:warning: Important notes on running `cargo test --test configure_profiles_test`
+For the automated tests, a [legacy API key](https://console.gomomento.com/api-keys) is required with the following settings:
+- **Type of key**: Super User Key
+- **Expiration**: highly recommended (Legacy keys do not support revocation.)
 
+```bash
+read -s -p "API key: " TEST_AUTH_TOKEN
+# Paste your API key. (Note: You will not be able to see it in the shell.)
+export TEST_AUTH_TOKEN
+make test
 ```
-export TEST_AUTH_TOKEN=<YOUR_TEST_AUTH_TOKEN>
-cargo test --test configure_profile_test
-```
 
-- If you already have existing credentials and config files locally, running `cargo test --test configure_profiles_test` with provided `TEST_AUTH_TOKEN_DEFAULT` will overwrite the value for token in your `default` profile.
-- The value for `TEST_CACHE_DEFAULT` needs to match the cache value in your `default` profile and the cache needs to exist. However, this cache will be deleted after this test runs successfully.
+### Formatting
+
+```bash
+make lint
+```
 
 ### Deploying
 

CONTRIBUTING.pt.md

@@ -1,22 +1,26 @@
 ## Construindo
 
 ```
-cargo build
+make build
 ```
 
-## Testando
+## Manual Testing
 
 Garanta que você tem os arquivos `~/.momento/credentials` e `~/.momento/config` com os seguintes dados.
 
 `~/.momento/credentials`
 
 ```
 [default]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 [YOUR_TEST_PROFILE]
-token=<YOUR_TOKEN>
+api_key_v2=<YOUR_TOKEN>
+endpoint=<YOUR_ENDPOINT_URL>
 ```
 
+- If you prefer, create a legacy API key instead (as for [automated testing](#automated-testing)), then set a `token` instead of `api_key_v2`/`endpoint`.
+
 `~/.momento/config`
 
 ```
@@ -28,26 +32,31 @@ cache=<YOUR_TEST_CACHE_WITH_PROFILE>
 ttl=700
 ```
 
-```
-export TEST_CACHE_DEFAULT=<YOUR_TEST_CACHE_DEFAULT>
-export TEST_CACHE_WITH_PROFILE=<YOUR_TEST_CACHE_WITH_PROFILE>
-export TEST_PROFILE=<YOUR_TEST_PROFILE>
-./run_test_sequentially.sh
-cargo clippy --all-targets --all-features -- -D warnings
+Follow the [README](./README.md#use-cli), using `./target/debug/momento` instead of `momento`, for example:
+
+```bash
+./target/debug/momento cache create example-cache
 ```
 
-<br>
+## Automated Testing
 
-:warning: Observações importantes sobre a execução `cargo test --test configure_profiles_test`
+For the automated tests, a [legacy API key](https://console.gomomento.com/api-keys) is required with the following settings:
+- **Type of key**: Super User Key
+- **Expiration**: highly recommended (Legacy keys do not support revocation.)
 
+```bash
+read -s -p "API key: " TEST_AUTH_TOKEN
+# Paste your API key. (Note: You will not be able to see it in the shell.)
+export TEST_AUTH_TOKEN
+make test
 ```
-export TEST_AUTH_TOKEN=<YOUR_TEST_AUTH_TOKEN>
-cargo test --test configure_profile_test
+
+### Formatting
+
+```bash
+make lint
 ```
 
-- Se você já tem credenciais e arquivos de configuração existentes em ambiente local, executar `cargo test --test configure_profiles_test` com o token `TEST_AUTH_TOKEN_DEFAULT` disponibilizado vai sobrescrever o valor do token no seu perfil `default`.
-- O valor do `TEST_CACHE_DEFAULT` precisa coincidir com o valor do cache no seu perfil `default` e o cache deve existir. Entretanto, este cache será removido após o teste ser executado com sucesso.
-  
 ### Implantação
 
 Depois do merge, um pull request será criado no repositório https://github.com/momentohq/homebrew-tap. Depois que o pull request passar por todas as validações, aprove o PR e aplique nele a tag `pr-pull`. Ele será então automaticamente mergeado pelo bot do homebrew e uma versão será criada para ele.

README.md

@@ -12,9 +12,11 @@ Command-line tool for managing Momento Serverless Cache.  Supports the following
 
 ## Prerequisites
 
-First things first - go to the [Momento Console](https://console.gomomento.com) to sign up. Generate an auth token to use with the CLI in the tokens tab.
+First things first - go to the [Momento Console](https://console.gomomento.com) to sign up. In the keys tab, generate an API key/token to use with the CLI.
 
-This token uniquely identifies cache interactions. The token should be treated like a sensitive password and all essential care must be taken to ensure its secrecy. We recommend that you store this token in a secret vault like AWS Secrets Manager. See the [docs](https://docs.momentohq.com/develop/guides/working-with-momento-auth-tokens) for more information on Momento auth tokens.
+This token uniquely identifies cache interactions. The token should be treated like a sensitive password and all essential care must be taken to ensure its secrecy. We recommend that you store this token in a secret vault like AWS Secrets Manager. See the [docs](https://docs.momentohq.com/topics/authentication/api-keys) for more information on Momento API keys.
+
+You'll also need your [endpoint URL](https://docs.momentohq.com/platform/regions).
 
 ## Installation
 
@@ -70,7 +72,7 @@ These instructions assume you have the `momento` executable on your path, after
 the appropriate installation steps above.
 
 ```
-# Configure your account with the auth token copied from the console
+# Configure your account with the API key and endpoint from above,
 # plus default cache name (`default-cache`) and TTL (600 seconds)
 # This will also create the cache `default-cache` in your account
 momento configure --quick
@@ -96,7 +98,7 @@ momento cache get key --cache example-cache
 momento configure
 ```
 
-This will prompt you for your Momento Auth Token, default cache name, default TTL, and save them to be reused as a part of your `default` profile.
+This will prompt you for your Momento API key (v2), endpoint, default cache name, default TTL, and save them to be reused as a part of your `default` profile.
 
 ```
 momento configure --profile new-profile