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

[ENH] Deployment guide updates #2906

Merged
merged 4 commits into from
Oct 9, 2024
Merged

[ENH] Deployment guide updates #2906

merged 4 commits into from
Oct 9, 2024

Conversation

itaismith
Copy link
Contributor

Description of changes

  • New dedicated Docker guide.
  • Updated AWS guide.
  • Dedicated authentication section for both Docker and AWS.
  • Update Cloudformation template, with a separate docker-compose file for better maintainability.

Test plan

Followed instructions to verify things are working.

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

This PR

Copy link

github-actions bot commented Oct 7, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor

@atroyn atroyn left a comment

Choose a reason for hiding this comment

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

Comments in Vercel. Additionally (possibly as follow-ups):

  • let's move thin-client out of the main guides
  • let's think about how we are going to separate 'client/server' from the main guide
  • let point at the deployment documentation at appropriate sections in the docs
  • let's add the perf evals in this section

@atroyn
Copy link
Contributor

atroyn commented Oct 9, 2024

send it

@itaismith itaismith merged commit cb88db2 into main Oct 9, 2024
66 of 68 checks passed
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.

2 participants