Skip to content

Minor API Key Readme Update - #286

Merged
sdhoyt merged 4 commits into
IMAP-Science-Operations-Center:mainfrom
sdhoyt:doc-update
Nov 6, 2025
Merged

Minor API Key Readme Update#286
sdhoyt merged 4 commits into
IMAP-Science-Operations-Center:mainfrom
sdhoyt:doc-update

Conversation

@sdhoyt

@sdhoyt sdhoyt commented Nov 5, 2025

Copy link
Copy Markdown
Contributor

Change Summary

Overview

In the documentation for setting the API Key, I moved the environment variable setting step to a line before using the imap-data-access, so it's more clear that it's not part of the imap-data-access command. I also added export for setting the environment variable

@sdhoyt
sdhoyt requested a review from greglucas November 5, 2025 20:21
@sdhoyt sdhoyt self-assigned this Nov 5, 2025
@sdhoyt sdhoyt added the documentation Improvements or additions to documentation label Nov 5, 2025
@sdhoyt sdhoyt added this to IMAP Nov 5, 2025
@sdhoyt

sdhoyt commented Nov 5, 2025

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@greglucas greglucas left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think that @tech3371 didn't want the export listed as a recommendation because then it sticks around for people in their environment and we don't want people accidentally uploading things in the future because they were still authenticated.

I'm fine with this though.

@sdhoyt

sdhoyt commented Nov 6, 2025

Copy link
Copy Markdown
Contributor Author

I think that @tech3371 didn't want the export listed as a recommendation because then it sticks around for people in their environment and we don't want people accidentally uploading things in the future because they were still authenticated.

I'm fine with this though.

@greglucas I'll remove the export. For some reason it didn't seem to work for me without it, but maybe I mistyped something

@sdhoyt

sdhoyt commented Nov 6, 2025

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@sdhoyt
sdhoyt merged commit d8962f4 into IMAP-Science-Operations-Center:main Nov 6, 2025
16 checks passed
@github-project-automation github-project-automation Bot moved this to Done in IMAP Nov 6, 2025
@sdhoyt
sdhoyt deleted the doc-update branch November 6, 2025 17:09
@greglucas

Copy link
Copy Markdown
Collaborator

It won't work like this, I agree. So we should either revert this or keep what you had before. The export sets it for the entire session of the terminal, so it does work across lines. Whereas this now sets it on one line, then the next line forgets it. Previously this was all on the same line so that the API_KEY would affect the entire line but only that one line/command and not subsequent ones. Does that make sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants