Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Key removal #745

Merged
merged 5 commits into from
Jul 3, 2024
Merged

Key removal #745

merged 5 commits into from
Jul 3, 2024

Conversation

asteiker
Copy link
Member

@asteiker asteiker commented Jul 3, 2024

Moving s3credential guidance into markdown for security reasons. This will remove expired aws keys from the notebook.


📚 Documentation preview 📚: https://earthaccess--745.org.readthedocs.build/en/745/

@asteiker asteiker requested review from mfisher87 and chuckwondo July 3, 2024 18:21
Copy link
Collaborator

@mfisher87 mfisher87 Jul 3, 2024

Choose a reason for hiding this comment

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

Maybe instead of having a code block inside markdown cell, we could have a code cell where the line is literally commented?

If we use the markdown block, can we add python highlighting? :)

```python
s3_credentials = auth.get_s3_credentials("NSIDC")
```

This line is commented out for security reasons. Please copy the following line into a new code block in order to obtain your credentials.

We could even bold this? Or make it stand out in some other way? It's easy to assume that "run all cells" will work.

Copy link
Member Author

Choose a reason for hiding this comment

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

@MattF-NSIDC Totally fair. I'm good with the first approach to simply comment the code cell itself. Fwiw the whole notebook does run successfully even without this line.

Copy link
Collaborator

@mfisher87 mfisher87 Jul 3, 2024

Choose a reason for hiding this comment

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

Ah OK, then maybe we don't have any reason to bold that note :)

Copy link
Member Author

Choose a reason for hiding this comment

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

@MattF-NSIDC I moved it to a commented code line. Let me know if you think this is now ready to merge.

Copy link
Collaborator

@chuckwondo chuckwondo left a comment

Choose a reason for hiding this comment

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

This is good for now to get the credentials removed. Hopefully we won't have to worry about removing the entire history, which would be painful.

Copy link
Collaborator

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@asteiker asteiker merged commit 2c42003 into main Jul 3, 2024
16 checks passed
@asteiker asteiker deleted the key-removal branch July 3, 2024 20:56
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