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

MB-1324 Add project overview to README #3490

Merged
merged 5 commits into from Feb 10, 2020
Merged

Conversation

@rswerve
Copy link
Contributor

rswerve commented Feb 6, 2020

Description

On Roci, we found that team members were answering the same questions every time a new engineer started on the project. We decided to gather the highlights and write them up. Please let me know if what we have here is accurate, sufficient, etc.

References

README.md Show resolved Hide resolved
Copy link
Contributor

tinyels left a comment

This is a great addition!

README.md Outdated

In addition to the front end interfaces, MilMove comprises a set of APIs that work over Mutual TLS:

`Contractors`: The API "the Prime" will use to communicate with the system. When the Prime needs information about a move (e.g., when is it scheduled?) or needs to update information about a move (e.g., what was the total weight of items moved?), it will use the `Contractors` API. As of this writing, this API is described in `prime.yaml`, but expect that name to change.

This comment has been minimized.

Copy link
@chrisgilmerproj

chrisgilmerproj Feb 7, 2020

Contributor

The contracts don't really use the word "Prime" and references to it are going to be removed from the codebase soon. So perhaps we just say "GHC"? Maybe @tinyels can weigh in there.

This comment has been minimized.

Copy link
@rswerve

rswerve Feb 7, 2020

Author Contributor

Removed mention of "The Prime"

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rswerve and others added 2 commits Feb 7, 2020
Co-Authored-By: Chris Gilmer <chris@truss.works>
Copy link
Contributor

chrisgilmerproj left a comment

🚀 - Thanks for the updates!

@rswerve rswerve merged commit c6cbd39 into master Feb 10, 2020
15 checks passed
15 checks passed
ci/circleci: acceptance_tests_experimental Your tests passed on CircleCI!
Details
ci/circleci: acceptance_tests_local Your tests passed on CircleCI!
Details
ci/circleci: acceptance_tests_staging Your tests passed on CircleCI!
Details
ci/circleci: build_app Your tests passed on CircleCI!
Details
ci/circleci: build_migrations Your tests passed on CircleCI!
Details
ci/circleci: build_storybook_app Your tests passed on CircleCI!
Details
ci/circleci: build_tasks Your tests passed on CircleCI!
Details
ci/circleci: build_tools Your tests passed on CircleCI!
Details
ci/circleci: check_generated_code Your tests passed on CircleCI!
Details
ci/circleci: client_test Your tests passed on CircleCI!
Details
ci/circleci: integration_tests Your tests passed on CircleCI!
Details
ci/circleci: pre_deps_golang Your tests passed on CircleCI!
Details
ci/circleci: pre_deps_yarn Your tests passed on CircleCI!
Details
ci/circleci: pre_test Your tests passed on CircleCI!
Details
ci/circleci: server_test Your tests passed on CircleCI!
Details
@rswerve rswerve deleted the MB-1324_ma_add_project_overview branch Feb 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.