Add instructions to securely manage token #2322
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
I've added this content into a twistie in the requested spots. I wonder about potential confusion around the nesting, though - particularly on the functions page, where two similar code blocks appear one after the other when the twistie is opened. An alternative would be to separate this information out into a separate page, and simply point to that page from the three requested spots. Does this merit a separate page or is it working in-context? Thoughts @beckykd @javabster @pandasa123 ? |
I wonder if it would make more sense to move the twistie after the save_account code block. You could also separate the information into another section so it stands out better. (Optional) Save your account informationYou can optionally use the save_account() method or environment variables... save account methodenvironment variables |
I like this idea to move save-account info into its own section - I'll mock it up. |
|
One or more of the following people are relevant to this code: |
docs/guides/setup-channel.mdx
Outdated
|
|
||
| ```python | ||
| import os | ||
| from qiskit_ibm_catalog import QiskitFunctionsCatalog |
There was a problem hiding this comment.
This example is only relevant for Functions, which not everyone uses. Should this code sample be for Runtime? And then Functions is a subsection?
There was a problem hiding this comment.
@pandasa123 we could use a Runtime code sample for the setup-channel page, and then use the one you provided for the Functions page (adding a separate section there). Sound ok?
There was a problem hiding this comment.
Actually, just spoke to Sanket in-person, who says it should work even when not using functions.
There was a problem hiding this comment.
But on https://docs.quantum.ibm.com/guides/install-qiskit we don't say to install qiskit-ibm-catalog, and there is no reason to install it unless you're using Functions.
There was a problem hiding this comment.
Actually, just spoke to Sanket in-person,
Just casually making us jealous...
Storing secrets in source code is extremely dangerous because source code gets checked into version control like Git. With reading from an environment variable, it is true that any process with access to |
Yes but that's not the alternative. We're proposing environment variables as an alternative to storing in a config file ( |
Co-authored-by: Eric Arellano <[email protected]>
Co-authored-by: Rebecca Dimock <[email protected]>
Co-authored-by: Rebecca Dimock <[email protected]>
|
@Eric-Arellano @pandasa123 I used tabs to demo the two ways to accomplish this. Do the tab labels make sense? (I used "Within Qiskit Runtime" and "Within Qiskit Functions") |
I don't fully disagree, but the number of people who share notebooks with their API token embedded inside is incredibly high. We should be telling them how to better handle their tokens
Yep |
Closes #2255