update readme documentation #365

gord5500 · 2023-07-06T13:55:45Z

Why

Main branch has no documentation currently

gord5500 · 2023-07-06T13:57:22Z

README.md

+
+## configure
+
+The `bmx configure` command creates or updates the global BMX configuration file, located at `~/.bmx/config`. This file can store your Okta organization, username, and your AWS default session duration. Okta account sessions are saved when a configuration file is present. For security reasons, it's recommended to avoid running `bmx configure` or creating a global configuration file on a machine used by multiple users.


Felt like configure needed a bit more than 1 sentence just for the fact about multi user machine and the worries we had with that

It could maybe go into a usage section above this actually

But do we trust someone to read it if they are only linked directly to the configure section

Agreed we should clarify what the "security reason" is. Since its intended as a feature.

For example: #175 thinks of it as a bug when it seems like a happy coincidence / or possibly intended but not documented in the original BMX.

We have this now:

bmx/src/D2L.Bmx/OktaAuthenticator.cs

Lines 76 to 77 in 4094b59

Console.Error.WriteLine( "No config file found. Your Okta session will not be cached. " +

"Consider running `bmx configure` if you own this machine." );

which I think adequately addresses possible user confusion.

README.md

gord5500 · 2023-07-06T16:45:05Z

README.md

+
+To setup AWS credentials in PowerShell, use:
+```PowerShell
+bmx print --account account-name --role role-name | iex


The copy code button seems kind of useless when we're adding dummy flag values in

Or it's just feels like it'll be more work to replace

gord5500 · 2023-07-06T17:35:19Z

Ah github doesn't care about the language in code blocks. Just turns to black anyways

README.md

Co-authored-by: Chenfeng Bao <[email protected]>

README.md

…to update_readme

README.md

Co-authored-by: Chenfeng Bao <[email protected]>

README.md

Co-authored-by: Chenfeng Bao <[email protected]>

cfbao · 2023-07-06T18:45:42Z

Can we use underscores (instead of dashes) for placeholder values? e.g.

bmx print --account account_name --role role_name | iex

Looking at the rendered view:

Dashes are red, and creates more noise to my eyes.
It's also easier for people to replace these placeholder values if we use underscores, as it'd be treated as a single word by most editors.

Co-authored-by: Chenfeng Bao <[email protected]>

update readme documentation

90e26f8

github-actions bot added the size/L A large PR. Could this be broken up? label Jul 6, 2023

gord5500 marked this pull request as ready for review July 6, 2023 13:56

gord5500 requested review from cfbao, jharoutuniand2l, scowing, boarnoah and DannyDaoBoYang as code owners July 6, 2023 13:56

gord5500 commented Jul 6, 2023

View reviewed changes

code examples

6015b98

gord5500 commented Jul 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

gord5500 commented Jul 6, 2023

View reviewed changes

typo

06c79db

cfbao reviewed Jul 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

gord5500 and others added 6 commits July 6, 2023 13:55

move note and config worry to bottom

b1bb9b9

Update README.md

b2e17e7

Co-authored-by: Chenfeng Bao <[email protected]>

Update README.md

f398324

Co-authored-by: Chenfeng Bao <[email protected]>

fix heading sizes

3cafe50

Update README.md

652c86f

Co-authored-by: Chenfeng Bao <[email protected]>

Update README.md

2a160fb

Co-authored-by: Chenfeng Bao <[email protected]>

boarnoah reviewed Jul 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

gord5500 added 2 commits July 6, 2023 13:59

redirect d2l users

ed8e29a

Merge branch 'update_readme' of https://github.com/Brightspace/bmx in…

d2b8ce8

…to update_readme

cfbao reviewed Jul 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

gord5500 and others added 2 commits July 6, 2023 14:00

change wording

df78a84

Update README.md

61d8635

Co-authored-by: Chenfeng Bao <[email protected]>

cfbao reviewed Jul 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

gord5500 and others added 2 commits July 6, 2023 14:28

Update README.md

5b13cd8

Co-authored-by: Chenfeng Bao <[email protected]>

Update README.md

edfc75f

Co-authored-by: Chenfeng Bao <[email protected]>

Update README.md

b455811

Co-authored-by: Chenfeng Bao <[email protected]>

gord5500 and others added 2 commits July 6, 2023 14:49

underscores

56549c5

Update README.md

ac793da

Co-authored-by: Chenfeng Bao <[email protected]>

cfbao approved these changes Jul 10, 2023

View reviewed changes

gord5500 merged commit a2c8c48 into main Jul 10, 2023
2 checks passed

gord5500 deleted the update_readme branch July 10, 2023 13:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update readme documentation #365

update readme documentation #365

gord5500 commented Jul 6, 2023

gord5500 Jul 6, 2023

gord5500 Jul 6, 2023

gord5500 Jul 6, 2023

boarnoah Jul 6, 2023 •

edited

Loading

cfbao Jul 6, 2023

gord5500 Jul 6, 2023

gord5500 Jul 6, 2023 •

edited

Loading

gord5500 commented Jul 6, 2023

cfbao commented Jul 6, 2023


		## configure

		The `bmx configure` command creates or updates the global BMX configuration file, located at `~/.bmx/config`. This file can store your Okta organization, username, and your AWS default session duration. Okta account sessions are saved when a configuration file is present. For security reasons, it's recommended to avoid running `bmx configure` or creating a global configuration file on a machine used by multiple users.

	Console.Error.WriteLine( "No config file found. Your Okta session will not be cached. " +
	"Consider running `bmx configure` if you own this machine." );

update readme documentation #365

update readme documentation #365

Conversation

gord5500 commented Jul 6, 2023

Why

gord5500 Jul 6, 2023

Choose a reason for hiding this comment

gord5500 Jul 6, 2023

Choose a reason for hiding this comment

gord5500 Jul 6, 2023

Choose a reason for hiding this comment

boarnoah Jul 6, 2023 • edited Loading

Choose a reason for hiding this comment

cfbao Jul 6, 2023

Choose a reason for hiding this comment

gord5500 Jul 6, 2023

Choose a reason for hiding this comment

gord5500 Jul 6, 2023 • edited Loading

Choose a reason for hiding this comment

gord5500 commented Jul 6, 2023

cfbao commented Jul 6, 2023

boarnoah Jul 6, 2023 •

edited

Loading

gord5500 Jul 6, 2023 •

edited

Loading