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

MMT-3954: Updating README #1332

Closed
wants to merge 3 commits into from
Closed

MMT-3954: Updating README #1332

wants to merge 3 commits into from

Conversation

mandyparson
Copy link
Contributor

@mandyparson mandyparson commented Dec 10, 2024

Overview

What is the feature?

The current README lacked information on running MMT in SIT or UAT mode so I've updated it to reflect that.

What is the Solution?

Added graph to Serverless Offline and some code changes that need to happen for UAT to run properly. Added statement under Running MMT about changing your token.

What areas of the application does this impact?

README

Testing

Reproduction steps

  • **Environment for testing: Local, SIT, and UAT
  • **Collection to test with: None
  1. Follow appropriate steps as outlined in document to make sure they all check out on your end.

Attachments

Preview:
Screenshot 2024-12-10 at 12 14 38 PM

Checklist

  • I have added automated tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.68%. Comparing base (30375f8) to head (bfb1d14).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1332   +/-   ##
=======================================
  Coverage   97.68%   97.68%           
=======================================
  Files         366      365    -1     
  Lines        5751     5752    +1     
  Branches     1207     1207           
=======================================
+ Hits         5618     5619    +1     
  Misses        132      132           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Environment|CLI|
|-|-|
|Local| $ npm run offline|
|SIT| $ EDL_PASSWORD=SIT Password npm run ffline
Copy link
Collaborator

Choose a reason for hiding this comment

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

put SIT Password in single quotes to be consistent with the UAT one below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I really wanted to eliminate anything that isn't absolutely needed as every variable can potentially break the sequence. I can make a note only UAT's edl password needs it?

"edl": {
"host": "https://uat.urs.earthdata.nasa.gov",
"uid": "mmt_uat"
},
```

_Note: The EDL_PASSWORD environment variable is required for group member queries to function._
Copy link
Collaborator

Choose a reason for hiding this comment

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

It is also required for validating tokens for UAT.

@mandyparson mandyparson requested a review from htranho December 10, 2024 19:13
@mandyparson mandyparson deleted the MMT-3954 branch December 10, 2024 20:00
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