Skip to content
This repository has been archived by the owner on Feb 25, 2024. It is now read-only.

docs: revamp docs #171

Merged
merged 34 commits into from
Aug 5, 2022
Merged

docs: revamp docs #171

merged 34 commits into from
Aug 5, 2022

Conversation

jjmachan
Copy link
Contributor

@jjmachan jjmachan commented Jun 28, 2022

Description

Add documentation for bentoctl. Added more info about philosophy, use of terraform and supported deployments.
closes:

@codecov
Copy link

codecov bot commented Jun 28, 2022

Codecov Report

Merging #171 (900677b) into main (180d38e) will decrease coverage by 1.39%.
The diff coverage is n/a.

❗ Current head 900677b differs from pull request most recent head 509177d. Consider uploading reports for the commit 509177d to get more accurate results

@@            Coverage Diff             @@
##             main     #171      +/-   ##
==========================================
- Coverage   60.27%   58.87%   -1.40%     
==========================================
  Files          24       24              
  Lines        1110     1138      +28     
==========================================
+ Hits          669      670       +1     
- Misses        441      468      +27     
Flag Coverage Δ
unit-tests 58.87% <ø> (-1.40%) ⬇️

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

Impacted Files Coverage Δ
bentoctl/utils/usage_stats.py 78.26% <0.00%> (-16.74%) ⬇️
bentoctl/cli/utils.py 61.76% <0.00%> (-11.77%) ⬇️
bentoctl/cli/__init__.py 82.75% <0.00%> (-2.30%) ⬇️
bentoctl/operator/registry.py 58.26% <0.00%> (-1.91%) ⬇️
bentoctl/docker_utils.py 24.65% <0.00%> (-0.70%) ⬇️
bentoctl/cli/operator_management.py 42.16% <0.00%> (+2.97%) ⬆️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

docs/quickstart.md Outdated Show resolved Hide resolved
@jjmachan jjmachan marked this pull request as ready for review July 14, 2022 14:18
@jjmachan jjmachan changed the title docs: polish docs: revamp docs Jul 14, 2022
@parano parano requested a review from aarnphm July 20, 2022 21:14
@jjmachan
Copy link
Contributor Author

jjmachan commented Aug 1, 2022

more doc ideas

  1. debugging guide explaining how to use --debug flag for issues related to build and intermediate bentos

Sagemaker

  1. give an architecture diagram
  2. option to deploy without lambda and API gateway services. They can invoke it directly which improves the latency, cost and has no timeout

README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
- building the bento for the cloud platform of choice
- creating the registry and pushing the bento into it
- generating the terraform project with the all required components
- facilitating gitops workflow for deploying models thanks to the tight
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- facilitating gitops workflow for deploying models thanks to the tight
- facilitating GitOps workflow for deploying models thanks to the tight

docs/customizing-deployments.md Outdated Show resolved Hide resolved
docs/customizing-deployments.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
@ssheng ssheng merged commit a3471f1 into bentoml:main Aug 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants