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

Leverage literalinclude to keep only one code copy and move autoscaler configs to annotations #665

Merged
merged 5 commits into from
Feb 13, 2025

Conversation

Jeffwan
Copy link
Collaborator

@Jeffwan Jeffwan commented Feb 13, 2025

Pull Request Description

  1. Move autoscaler configs to annotations. defining them in labels is kind of an issue, just found this problem in the examples
  2. Reformat all the autoscaler configurations.
  3. Remove all code samples in the docs, those are kind of hard to maintain. At the same time, leverage literalinclude to refer the sample code. In the end, we just need to maintain one code copy which is much easier.

Related Issues

Resolves: #664

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

This is to avoid duplication. literalinclude perfectly helps address such issue. We just need to maintain the example code files and doc will be automatically updated.

Signed-off-by: Jiaxin Shan <[email protected]>
gangmuk pushed a commit that referenced this pull request Feb 13, 2025
@Jeffwan Jeffwan merged commit b4cb471 into main Feb 13, 2025
10 checks passed
@Jeffwan Jeffwan deleted the jiaxin/sample-file-reference branch February 13, 2025 18:03
Jeffwan pushed a commit that referenced this pull request Feb 13, 2025
* fixed manifest with name without v100, recording per request log in pod log streaming, updated script to use deploy.yaml instead of reusing existing deployment

* fixed the indentations (two spaces)

* Reformat autoscaler yamls based on #665

---------

Co-authored-by: Gangmuk <[email protected]>
varungup90 pushed a commit that referenced this pull request Feb 20, 2025
…r configs to annotations (#665)

* Move auotscaling configs to annotations and reformat files

* Leverage existing sample files in docs

This is to avoid duplication. literalinclude perfectly helps address such issue. We just need to maintain the example code files and doc will be automatically updated.

* Move autoscaler configurations to annotations

* Address code review feedbacks

* Remove the empty lines

---------

Signed-off-by: Jiaxin Shan <[email protected]>
Signed-off-by: Varun Gupta <[email protected]>
varungup90 pushed a commit that referenced this pull request Feb 20, 2025
* fixed manifest with name without v100, recording per request log in pod log streaming, updated script to use deploy.yaml instead of reusing existing deployment

* fixed the indentations (two spaces)

* Reformat autoscaler yamls based on #665

---------

Co-authored-by: Gangmuk <[email protected]>
Signed-off-by: Varun Gupta <[email protected]>
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.

Move autoscaling configuration to annotations
2 participants