Help Wanted: users.json generation code samples don't say what language they're in

[icelander]

trafficstars

On this page we provide code samples for generating a users.json file from various providers, but give no instructions on how to run this code or even what language it's in. I think it might be Python but whoever wrote it should clarify.

[justinegeffen]

Thanks, @icelander. The docs have been written by multiple contributors so it's difficult to isolate the author of this section. @wiersgallak may have some insight into this though.

[achintya-7]

Hey, can I work on this issue

[cwarnermm]

@achintya-7 - Do you continue to be interested in working on this docs request?

[achintya-7]

@achintya-7 - Do you continue to be interested in working on this docs request?

Sure, I will look into it.

[achintya-7]

@cwarnermm I looked into the docs and all the three user file generation methods are written in Python. Can you suggest to me what further action should I take here?

[cwarnermm]

Thanks, @achintya-7! The next step for this documentation ticket would be to create a PR with requested changes. As noted in the original request, the sample OneLogin, OKTA, and ADFS scripts provided in the product documentation are missing important context that will help users succeed, including a confirmation that the scripts are written in Python, and details on how to run those Python scripts in a real-world scenario.

One thing I'd like to clarify with our Product Management team is how far we want to take this content update request, given that the CLI has been replaced, as of Mattermost v6.0, with the mmctl command line tool.

@wiersgallak - What are your thoughts on applying content clarifications for our CLI product documentation?

[achintya-7]

I self-hosted my own Mattermost server via docker. It uses the new mmctl CLI. When looking into the documents for user migrate_auth, it only has the commands using the mattermost CLI tool.

By looking at various other commands on the same page, most of the command functions has a note box linking to its mmctl alternative page. I think it would be a good idea to add it as well. We can then reference the link to this page : user_auth

For the Python script for the making of users_json,

OneLogin requires 3 arguments which are to be inputted

client_id	Required: A valid OneLogin API client_id
client_secret	Required: A valid OneLogin API client_secret
region	Optional: us or eu. Defaults to us

Okta requires 2 arguments which are to be inputted

okta url	An Okta account, called an organization
token	Your API token