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

Docker setup documentation #416

Merged
merged 3 commits into from
May 23, 2024
Merged

Docker setup documentation #416

merged 3 commits into from
May 23, 2024

Conversation

kmcginnes
Copy link
Collaborator

@kmcginnes kmcginnes commented May 22, 2024

Description

Updated the documentation to better describe the docker setup and reformatted other parts of the documentation to improve readability.

Also, fixed the log message when the Express server starts.

Validation

  • Read through the documentation changes.
  • Verify the steps in the documentation work as intended
  • Run the proxy server to see the updated log message

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0
    license.
  • I have run pnpm checks to ensure code compiles and meets standards.
  • I have run pnpm test to check if all tests are passing.
  • I have covered new added functionality with unit tests if necessary.
  • I have added an entry in the Changelog.md.

Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 14.91%. Comparing base (361c4ba) to head (625853e).
Report is 21 commits behind head on main.

Current head 625853e differs from pull request most recent head 1933d13

Please upload reports for the commit 1933d13 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #416      +/-   ##
==========================================
+ Coverage   13.97%   14.91%   +0.93%     
==========================================
  Files         414      415       +1     
  Lines       30639    30809     +170     
  Branches      878      946      +68     
==========================================
+ Hits         4283     4595     +312     
+ Misses      26026    25886     -140     
+ Partials      330      328       -2     
Flag Coverage Δ
unittests 14.91% <ø> (+0.93%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@kmcginnes kmcginnes marked this pull request as ready for review May 22, 2024 22:44
Copy link
Member

@michaelnchin michaelnchin left a comment

Choose a reason for hiding this comment

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

Thanks @kmcginnes !

@kmcginnes kmcginnes merged commit fd35e48 into aws:main May 23, 2024
1 check passed
@kmcginnes kmcginnes deleted the docker-setup branch May 23, 2024 14:34
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.

[Task] Improve local docker setup documentation [Task] Update Readme.md organization to be more clear
3 participants