Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve getting started instructions #4

Open
copernico opened this issue Jun 18, 2020 · 2 comments
Open

Improve getting started instructions #4

copernico opened this issue Jun 18, 2020 · 2 comments

Comments

@copernico
Copy link

The instructions at https://github.com/SAP/credential-digger#install should include some details as to what values should be put in the two fields:

test_model=
path_model=

Actually, a comment in the sample .env file would do.

@marcorosa
Copy link
Member

I agree.
I added a sample link and update the README with the instructions on how to use the models in the container.

@copernico
Copy link
Author

copernico commented Jul 1, 2020

Hi @marcorosa, I would advise to put all that is needed right in the section https://github.com/SAP/credential-digger#install

I would expect that when I run the steps in that section I end up with a fully functional instance (which is not the case, because I get no rules).

Overall, I would suggest to provide a very simple path from zero to a fully working instance of the tool in one clear set of steps. Optional or alternative ways should be identified as such and documented separately. Right now the readme provides too much information and alternatives, but not the single one-stop-shop for the curious newcomer and prospective adopter.

EDIT: also the section https://github.com/SAP/credential-digger#architecture should be moved down in the readm, or to a separate file altogether (better): that breaks the flow from the high-level description of what the tool does to how to actually try it; the question about how it is architected come later and only for a limited class of users.

@marcorosa marcorosa reopened this Jul 3, 2020
marcorosa pushed a commit that referenced this issue Aug 3, 2020
My exp repo <- Original repo
@marcorosa marcorosa mentioned this issue Jan 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants