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

*: readme updates for v2 #674

Merged
merged 2 commits into from
Nov 8, 2016
Merged

Conversation

ericchiang
Copy link
Contributor

Final couple of changes before we switch dev to master.

cc @ElijahCaine @rithujohn191

@ericchiang ericchiang force-pushed the readme-docs-v2 branch 3 times, most recently from 6ad1563 to 0719f3e Compare November 8, 2016 18:10
Copy link
Contributor

@rithujohn191 rithujohn191 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few observations

./bin/dex serve examples/config-dev.yaml
```

The [example config](../examples/config-dev.yaml) file documents many of the configuration options through inline comments. For extra config options, look at that file.
Copy link
Contributor

@rithujohn191 rithujohn191 Nov 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a relative link. It links to whatever branch you're on. Very useful for when we switch master.

Actually now that I think about it, I'll probably update the api.md links too.


To interact with dex, like any other OAuth2 provider, users first visit a client app and are then redirected to dex to login. Dex ships with a example client app (also built with the `make` command), for testing and demos.

UThe example app's flags default to user the statically configured OAuth2 client credentials in the `config-dev.yaml` file. Run the example app will cause it to query dex's [discovery endpoint][oidc-discovery] and determine the OAuth2 endpoints.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: typo UThe

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! updated

Copy link
Contributor

@pop pop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ericchiang This is looking really good. Just have a few comments on sentence flow and structure.

./bin/dex serve examples/config-dev.yaml
```

The [example config](../examples/config-dev.yaml) file documents many of the configuration options through inline comments. For extra config options, look at that file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link should be a reference, not inline.

Dex requires a Go installation and a GOPATH configured. For setting up a Go workspace, refer to the [official documentation][go-setup]. Clone it down the correct place, and simply type `make` to compile the dex binary.

```
git clone https://github.com/coreos/dex.git $GOPATH/src/github.com/coreos/dex
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code-block commands should start with $

make
```

A containerized version of this document using [rkt][rkt-repo] or Docker will be added later.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is confusing. Can you elaborate as to what that means or remove/comment it out?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed


## Configuration

Dex is a single, scalable binary that pulls all configuration from a config file (no command line flags). Use the example config file defined in the `examples` folder to start up dex with an in-memory data store.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

examples should link to the config being referenced to.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would reword this to be:


Dex exclusively pulls configuration options from a config file. Use the [example config][example-config] file found in the examples/ directory to start an instance of dex with an in-memory data store.


## Running a client

To interact with dex, like any other OAuth2 provider, users first visit a client app and are then redirected to dex to login. Dex ships with a example client app (also built with the `make` command), for testing and demos.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would reword this to be:


Dex operates like most other OAuth2 providers. Users are redirected from a client app to dex to login. Dex ships with [...]


To interact with dex, like any other OAuth2 provider, users first visit a client app and are then redirected to dex to login. Dex ships with a example client app (also built with the `make` command), for testing and demos.

The example app's flags default to user the statically configured OAuth2 client credentials in the `config-dev.yaml` file. Run the example app will cause it to query dex's [discovery endpoint][oidc-discovery] and determine the OAuth2 endpoints.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would reword this to be:


The example application pulls configuration options from [config-dev.yml][config-dev]. Running the example app [...]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to add this statement a little earlier.

Use the [example config][example-config] file found in the examples/ directory to start an instance of dex with an in-memory data store and a set of predefined OAuth2 clients.

Then change this to

By default, the example client is configured with the same OAuth2 credentials defined in examples/config-dev.yaml to talk to dex. Running the example app will cause it to query dex's [discovery endpoint][oidc-discovery] and determine the OAuth2 endpoints.

That work?

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

Successfully merging this pull request may close these issues.

3 participants