From 601aeda0429838692ab8d02a6b5b3b634e44af1e Mon Sep 17 00:00:00 2001 From: Jean-Pierre Sevigny <41591249+sevignyj@users.noreply.github.com> Date: Wed, 8 Feb 2023 18:21:57 -0500 Subject: [PATCH] doc formatting fix --- README.md | 6 ++++-- docs/README.md | 4 ++-- tests/README.md | 8 ++++---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fde7e959..2b16484b 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,6 @@ command](https://github.com/dowjones/tokendito/blob/main/docs/README.md#single-c Have multiple Okta tiles to switch between? View our [multi-tile guide](https://github.com/dowjones/tokendito/blob/main/docs/README.md#multi-tile-guide). -### Tips, tricks, troubleshooting, examples, and more docs are [here]()https://github.com/dowjones/tokendito/blob/main/docs/README.md! -[Contributions are welcome](https://github.com/dowjones/tokendito/blob/main/docs/CONTRIBUTING.md)! ## Docker @@ -110,3 +108,7 @@ Tokendito profiles are supported while using containers provided the proper volu ``` txt docker run -ti -v ${home}:/home/tokendito/ tokendito --profile my-profile-name ``` + +## Tips, tricks, troubleshooting, examples, and more docs are [here](https://github.com/dowjones/tokendito/blob/main/docs/README.md) + +[Contributions are welcome](https://github.com/dowjones/tokendito/blob/main/docs/CONTRIBUTING.md)! diff --git a/docs/README.md b/docs/README.md index 2df30dfb..fa680fa7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -45,7 +45,7 @@ this! You can just pass in your information at runtime: -``` sh +``` txt tokendito --username prod_service_user@company.com \ --role-arn arn:aws:iam::123456789000:role/dowjones-engineer \ --okta-mfa push \ @@ -64,7 +64,7 @@ role_arn = arn:aws:iam::123456789000:role/engineer And execute: -``` sh +``` txt tokendito --profile engineer ``` diff --git a/tests/README.md b/tests/README.md index d9fbdefd..2fbb5046 100644 --- a/tests/README.md +++ b/tests/README.md @@ -19,7 +19,7 @@ credentials. # Example 1 -``` sh +``` txt py.test -v -rA -s tests --config-file=/tmp/my-tokendito-config.ini ``` @@ -27,7 +27,7 @@ Where the config file has valid configuration items for the tool. ## Example 2 -``` sh +``` txt py.test -v -rA -k 'functional' -s tests \ --username=jane.doe@mycompany.com \ --password=mysecretpass \ @@ -41,7 +41,7 @@ This triggers the tests `test_generate_credentials` and ## Example 3 -``` sh +``` txt TOKENDITO_OKTA_MFA_METHOD=push py.test -v -rA -k 'functional' -s tests --username=... ``` @@ -50,7 +50,7 @@ arguments. ## Example 4 -``` sh +``` txt TOKENDITO_OKTA_PASSWORD='mysecretpass' tox -e auth -- --username='jane.doe@mycompany.com' ```