Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

docs: add documentation for login form configuration#50705

Merged
kopancek merged 7 commits into
mainfrom
milan_docs_login_form
Apr 17, 2023
Merged

docs: add documentation for login form configuration#50705
kopancek merged 7 commits into
mainfrom
milan_docs_login_form

Conversation

@kopancek

Copy link
Copy Markdown
Contributor

Description

Added logs for configuring the login form. Can be seen here.

Test plan

Eyeballing of the rendered docs pages.

@cla-bot cla-bot Bot added the cla-signed label Apr 17, 2023
@kopancek kopancek requested a review from a team April 17, 2023 09:15
@sourcegraph-bot

sourcegraph-bot commented Apr 17, 2023

Copy link
Copy Markdown
Contributor

Codenotify: Notifying subscribers in CODENOTIFY files for diff bdda34a...554c877.

Notify File(s)
@sourcegraph/delivery doc/admin/auth/index.md
doc/admin/auth/login_form.md

@pjlast pjlast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Some language suggestions

Comment thread doc/admin/auth/index.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment on lines +20 to +24
If there are multiple auth providers configured, by default the login form displays a login button for each of them.
This is displayed in a specific order that is hardcoded in the application.

To change the order, each auth provider now has an optional `order` parameter. It is an integer and items
will be sorted in natural order (1, 2, 3, ...).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
If there are multiple auth providers configured, by default the login form displays a login button for each of them.
This is displayed in a specific order that is hardcoded in the application.
To change the order, each auth provider now has an optional `order` parameter. It is an integer and items
will be sorted in natural order (1, 2, 3, ...).
When multiple auth providers are configured, the default login form displays a login button for each of them.
Each auth provider has an optional `order` parameter. It is an integer and items
will be sorted in natural order (1, 2, 3, ...).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Reworded it a bit, so that we still keep the portion about default ordering being hardcoded. I'd like to be transparent here, that adding order param is the only way to override that.

Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
Comment thread doc/admin/auth/login_form.md Outdated
kopancek and others added 6 commits April 17, 2023 16:32
Co-authored-by: Petri-Johan Last <petri.last@sourcegraph.com>
Co-authored-by: Petri-Johan Last <petri.last@sourcegraph.com>
Co-authored-by: Petri-Johan Last <petri.last@sourcegraph.com>
Co-authored-by: Petri-Johan Last <petri.last@sourcegraph.com>
Co-authored-by: Petri-Johan Last <petri.last@sourcegraph.com>
@pjlast

pjlast commented Apr 17, 2023

Copy link
Copy Markdown
Contributor

Thanks! :shipit:

@kopancek kopancek merged commit e842ff6 into main Apr 17, 2023
@kopancek kopancek deleted the milan_docs_login_form branch April 17, 2023 15:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants