Skip to content

Mention how to use a CIAM tenant #105

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.

Sign up for GitHub

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

Merged
rayluo merged 1 commit into from
May 14, 2023
Merged

Mention how to use a CIAM tenant #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@
CLIENT_ID=<client id>
CLIENT_SECRET=<client secret>

# Expects a full authority URL such as "https://login.microsoftonline.com/TENANT_GUID"
# or "https://login.microsoftonline.com/contoso.onmicrosoft.com".
# The AUTHORITY variable expects a full authority URL.
#
# If you are using an AAD tenent, configure it as
# "https://login.microsoftonline.com/TENANT_GUID"
# or "https://login.microsoftonline.com/subdomain.onmicrosoft.com".
#
# If you are using a CIAM tenant, configure it as "https://subdomain.ciamlogin.com"

@pamelafox pamelafox May 14, 2023

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.

One concern I have with having so much information inside the code sample is internationalization- I assume that this will still show up as English when embedded in non-en translated sites, unless they have some approach to translate it. I don't know if there's a single place to put this info on learn.com, however, so maybe this is the best approach of the options.

@rayluo rayluo May 14, 2023 •
edited
Loading

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.

I understand where you are coming from, and it is true all the comments in this env.sample could show up as-is when embedded in non-en translated sites (more on this in a minute). I think that is fine in a sense that the programming source code is historically English-dominant, and this env.sample configuration file is technically still part of the source code.

I would still suggest to keep these comments here as the single source of truth which will more likely stay in-sync with the underlying sample logic, simply because they are in the same repo.

Note that the English comments inside this configuration file does not prevent the content team from referencing line 16 #AUTHORITY=<authority url> ONLY, while maintaining multi-language instructions on learn.microsoft.com, should they choose to do so.

So, now you can decide whether to go with the aforementioned "referencing line 16 only" approach, or to render the entire env.sample as-is (so that you do not have to update the quickstart doc as often).

#
# Alternatively, leave it undefined if you are building a multi-tenant app in world-wide cloud
#AUTHORITY=<authority url>