sharing exp: document studio.token

[skshetry]

Related #4440.

I did not add any visuals for exp push as I did not see if it fit into command reference. Maybe that should be accommodated in the guide or tutorials.

[github-actions]

Link Check Report

There were no links to check!

[dberenbaum]

@daavoo @skshetry It feels like we need to clean up the env vars and make them more consistent between live sharing and exp push. I think it's the last blocker for general usage of the exp sharing features. WDYT? Can one of you take it?

[skshetry]

I'm a bit hesitant to add env vars for every config. :(

[skshetry]

Now that the access token is used by dvc too, I think we need to rewrite this page or extract it out.

[daavoo]

That is a good point.
Probably outside the scope of the P.R. and better to be discussed in #4440

I would perhaps not touch this introduction for now and leave the page to be only about live updates

[skshetry]

I think we should at least mention "to send experiments" here as we are redirecting here for setup instructions. Let me know what you think (that's the only change here btw).

[daavoo]

I think we should at least mention "to send experiments" here as we are redirecting here for setup instructions. Let me know what you think (that's the only change here btw).

I am ok with merging this as it is.

we are redirecting here for setup instructions

As you mentioned, what we probably need to do is to extract the info, for example having something like a connect to Studio page that doesn't get into the downstream use case (live updates, exp push, etc.), and use that page for cross reference

[dberenbaum]

Looks okay to me for now. I'm a little hesitant to say we need another page just for how to setup an access token. Feels like it creates more friction for live sharing. @tapadipti PTAL and add any thoughts you have.

[dberenbaum]

@tapadipti Do we have `any of the other env variables mentioned in this guide? For customers who have on-prem Studio, how do they know how to configure live metrics and plots?

[skshetry]

I'm a little hesitant to say we need another page just for how to setup an access token.

yeah, I think it's simple enough that we don't need to have a separate page. If we need it, it might be a UX problem. (For 1, I get confused between Settings page and Profile page in Viewer).

[daavoo]

@daavoo @skshetry It feels like we need to clean up the env vars and make them more consistent between live sharing and exp push. I think it's the last blocker for general usage of the exp sharing features. WDYT? Can one of you take it?

@dberenbaum Do you also mean that DVCLive should check for dvc config?

[skshetry]

@daavoo, I understood it to just envvars. See #4470 (comment).

[dberenbaum]

Suggested change

	view experiments. Check
	[this guide on how to setup an access token](/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots#set-up-an-access-token).
	view experiments. [Get the token](https://studio.iterative.ai/user/_/profile?section=accessToken) or check
	[this guide on how to create and manage an access token](/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots#create-and-manage-access-token).

Rather go through more docs, I would suggest we first try to send people directly to a link to get their token. If they have an on-prem setup or special needs, we can also link to the guide. I'd rather link to the Create and manage access token of the guide since it gets directly to how to get the token.

[dberenbaum]

Should we mention the Studio URL config also here? Ideally, it should be in the linked guide IMO.

[skshetry]

Is that underscore URL stable and guaranteed to work? And not the side effect of frameworks that they use?

[skshetry]

Note that above the url does not handle if you are logged out

[dberenbaum]

Is that underscore URL stable and guaranteed to work? And not the side effect of frameworks that they use?

I got it from VS Code, who is using it to direct users to the token. @iterative/studio can answer whether it's stable I guess.

Note that above the url does not handle if you are logged out

You mean it doesn't redirect after login?

[skshetry]

Thankyou @mvshmakov for confirmation. One more question, is it possible to redirect after login?

[mvshmakov]

One more question, is it possible to redirect after login?

Yes, with conventional ?next={url}. Better to double-check before writing it down.

[skshetry]

I meant if it's possible to handle that on Studio side without doing anything here.

[mvshmakov]

I'm not sure what you mean. Is this a question about whether it is possible to make this link work even if the user is logged out? E.g., if the user is not logged in, to redirect the user to the login page and after a login redirect to the URL which was passed before?

We have to consider a few edge cases here, and now it is not supported. If this is what you wanted, please create an issue in the Studio repo. If not, could you please elaborate on the question a bit more?

[skshetry]

Is this a question about whether it is possible to make this link work even if the user is logged out? E.g., if the user is not logged in, to redirect the user to the login page and after a login redirect to the URL which was passed before?

yes, that's what I meant. Will create an issue. Thanks.

[dberenbaum]

@skshetry Left a couple suggestions to directly link to the Studio profile page to get the token. I think not some users just want to know where to find the token. If you're okay with those, I think it's ready to merge and we can follow up on other questions about how to reorganize the Studio docs.

[dberenbaum]

Thanks @skshetry! Sorry, didn't get a chance to approve it after your latest changes, but looks good.