Skip to content

Add docs for cc-login#148

Open
pdmars wants to merge 3 commits intomasterfrom
docs/cc-login
Open

Add docs for cc-login#148
pdmars wants to merge 3 commits intomasterfrom
docs/cc-login

Conversation

@pdmars
Copy link
Contributor

@pdmars pdmars commented Mar 25, 2026

No description provided.

@marcwitasee
Copy link
Contributor

@pdmars looks good. I'd suggest adding some language to the authentication and rc_script page as well pointing users to the new cc-login. We are planning to deprecate rc_script as well, correct?

@pdmars
Copy link
Contributor Author

pdmars commented Mar 25, 2026

@pdmars looks good. I'd suggest adding some language to the authentication and rc_script page as well pointing users to the new cc-login. We are planning to deprecate rc_script as well, correct?

At a minimum I think we'd remove cc-generate-openrc (though I'm not sure we have this documented anywhere?), but the openrc page is a bit more general. They can still use this cc-login tool to generate an openrc file, or they can download one from the UI still, etc.

I'll add a note on the openrc page directing users to cc-login as a means to generate an openrc file on an instance.

Copy link
Contributor

@Mark-Powers Mark-Powers left a comment

Choose a reason for hiding this comment

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

I agree with Marc.

Can you clarify what the new workflow is with this command? It might be useful to explain what the user will be asked. My understanding is when a user runs it they will need to open a link in their browser as well. Also when we update cc-snapshot to use this, will the user first have to source an openrc?

@pdmars
Copy link
Contributor Author

pdmars commented Mar 25, 2026

I agree with Marc.

Can you clarify what the new workflow is with this command? It might be useful to explain what the user will be asked. My understanding is when a user runs it they will need to open a link in their browser as well. Also when we update cc-snapshot to use this, will the user first have to source an openrc?

Sure, I can describe the workflow a bit. Should it just be on the cc-login doc page, or is there a better place for us to describe the workflow? Right now I don't think we describe the workflow with cc-generate-openrc, for instance.

@Mark-Powers
Copy link
Contributor

Maybe it fits in the section here. You say "The command performs device authentication" but I don't expect a user will understand what that means.

@pdmars
Copy link
Contributor Author

pdmars commented Mar 25, 2026

@marcwitasee @Mark-Powers addressed both your feedback, I think. Take a look and let me know if there's anything / anywhere else we should clarify things for this change.

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