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: Ensure CRD inline code consistency #265

Merged
merged 1 commit into from
Oct 25, 2022
Merged

docs: Ensure CRD inline code consistency #265

merged 1 commit into from
Oct 25, 2022

Conversation

rafvasq
Copy link
Member

@rafvasq rafvasq commented Oct 21, 2022

Motivation

Reading through the docs, I noticed that the majority of references to CRDs used inline code (e.g. InferenceService, InferenceServices, InferenceService's) but in many instances inline code blocks weren't used, sometimes within the same document.

Modifications

Updated references to ServingRuntimes or InferenceServices to use inline code blocks for consistency along with a couple of typo fixes.

Result

Consistent references to CRDs and less confusion to the reader.

@rafvasq rafvasq added the documentation Improvements or additions to documentation label Oct 21, 2022
@rafvasq rafvasq requested a review from njhill October 21, 2022 17:23
@rafvasq rafvasq self-assigned this Oct 21, 2022
@kserve-oss-bot kserve-oss-bot requested a review from Tomcli October 21, 2022 17:23
@rafvasq rafvasq requested review from chinhuang007 and removed request for Tomcli October 21, 2022 18:05
@chinhuang007
Copy link
Contributor

@rafvasq Thanks for the fixes! Can you run ./scripts/develop.sh make fmt to ensure there is no lint issues?

@rafvasq
Copy link
Member Author

rafvasq commented Oct 21, 2022

@chinhuang007 Thanks for the reminder, I've run it. No more lint issues.

Copy link
Contributor

@chinhuang007 chinhuang007 left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Member

@njhill njhill left a comment

Choose a reason for hiding this comment

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

Thanks @rafvasq

@kserve-oss-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chinhuang007, njhill, rafvasq

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@chinhuang007
Copy link
Contributor

/lgtm

@kserve-oss-bot kserve-oss-bot merged commit bdfe029 into kserve:main Oct 25, 2022
@rafvasq rafvasq deleted the doc-revise branch October 25, 2022 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved documentation Improvements or additions to documentation lgtm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants