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

docs: Simplify packaging docs #5116

Merged
merged 4 commits into from
Dec 13, 2024

Conversation

Sherlock113
Copy link
Contributor

@Sherlock113 Sherlock113 commented Dec 10, 2024

What does this PR address?

This pr simplifies the existing Bento packaging doc.

  1. Keep the Bento build and containerization doc in Get started short and simple.
  2. The full list of Bento build options are moved to reference.
  3. After bentofile.yaml is deprecated, we can further change the doc as necessary.

Before submitting:

Signed-off-by: Sherlock113 <sherlockxu07@gmail.com>
@Sherlock113 Sherlock113 requested a review from a team as a code owner December 10, 2024 03:52
@Sherlock113 Sherlock113 requested review from frostming and removed request for a team December 10, 2024 03:52
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

3 files reviewed, 5 total issue(s) found.

The style guide flagged several spelling errors that seemed like false positives. We skipped posting inline suggestions for the following words:

  • base_image
  • amazonlinux
  • distro
  • debian
  • pathspecs
  • setup_script
  • python_version
  • requirements_txt
  • trusted_host
  • Conda
  • cuda_version
  • prepended
  • Dockerfile
  • Bentos
  • distros
  • system_packages
  • no_index
  • lock_packages
  • index_url
  • dockerfile_template
  • bento
  • find_links
  • Distro
  • conda
  • extra_index_url
  • pip_args
  • Bento

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

3 files reviewed, 4 total issue(s) found.

The style guide flagged several spelling errors that seemed like false positives. We skipped posting inline suggestions for the following words:

  • [Pp]athspecs
  • BentoCloud

docs/source/get-started/packaging-for-deployment.rst Outdated Show resolved Hide resolved
@Sherlock113 Sherlock113 self-assigned this Dec 10, 2024
@Sherlock113 Sherlock113 added the documentation Documentation, tutorials, and example projects label Dec 10, 2024
Signed-off-by: Sherlock113 <sherlockxu07@gmail.com>
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

3 files reviewed, 3 total issue(s) found.

Signed-off-by: Sherlock113 <sherlockxu07@gmail.com>
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

3 files reviewed, 3 total issue(s) found.

The style guide flagged several spelling errors that seemed like false positives. We skipped posting inline suggestions for the following words:

  • [Dd]istro
  • build_ctx

@Sherlock113 Sherlock113 merged commit 4b49b8c into bentoml:main Dec 13, 2024
52 of 53 checks passed
@Sherlock113 Sherlock113 deleted the docs/simplify-packaging-doc branch December 13, 2024 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, tutorials, and example projects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants