Skip to content

Latest commit

 

History

History
133 lines (112 loc) · 3.55 KB

template-blog.md

File metadata and controls

133 lines (112 loc) · 3.55 KB
Raw

Blog template instructions

An example template with best-practices that you can use to start drafting an entry to post on the KServe blog.

Copy a version of this template without the instructions

Include a commented-out table with tracking info about reviews and approvals:

<!--
| Reviewer           | Date       | Approval      |
| ------------------ | ---------- | ------------- |
| <!-- GitHub ID --> | YYYY-MM-DD | :+1:, :monocle_face:, :-1: |
| <!-- GitHub ID --> | YYYY-MM-DD | :+1:, :monocle_face:, :-1: |
-->

Blog content body

<!--
Introduce the feature you are going to explain:
 * state what the goal of this blog entry is
 * how you use the feature
 * make sure to link to the corresponding docs
 * why others can find it useful (why its important)
-->

<!-- Add/create as many distinct Steps or Sections as needed. -->

Example step/section 1:

<!--
An introductory sentence about this step or section (ie. why its important and what the result is).
Don't forget to link to any new or related concepts that you mention here.
-->

Example step/section 2:

<!--
An introductory sentence about this step or section (ie. why its important, how it relates to the one before, and what the result is)
Don't forget to link to any new or related concepts that you mention here.
-->

Example step/section 3:

<!--
An introductory sentence about this step or section (ie. why its important, how it relates to the one before, and what the result is)
Don't forget to link to any new or related concepts that you mention here.
-->

Example section about results

<!--
Tie it all together and briefly revisit the main key points and then the overall result/goal/importance
-->

Further reading

<!--
Add any links to other related resources that users might find useful.
What's the next step?
-->

About the author

<!--
Add a short bio of yourself here
-->

Copy the template

<!--
| Reviewer           | Date       | Approval      |
| ------------------ | ---------- | ------------- |
| <!-- GitHub ID --> | YYYY-MM-DD | :+1:, :monocle_face:, :-1: |
| <!-- GitHub ID --> | YYYY-MM-DD | :+1:, :monocle_face:, :-1: |
-->

# <!-- Insert blog title here -->

## Blog content body
<!-- Introduce the feature you are going to explain:
 * state what the goal of this blog entry is
 * how you use the feature
 * make sure to link to the corresponding docs
 * why others can find it useful (why its important)
-->

<!-- Add/create as many distinct Steps or Sections as needed. -->
### Example step/section 1:
<!--
An introductory sentence about this step or section (ie. why its important and what the result is).
Don't forget to link to any new or related concepts that you mention here.
-->

### Example step/section 2:
<!--
An introductory sentence about this step or section (ie. why its important, how it relates to the one before, and what the result is)
Don't forget to link to any new or related concepts that you mention here.
-->

### Example step/section 3:
<!--
An introductory sentence about this step or section (ie. why its important, how it relates to the one before, and what the result is)
Don't forget to link to any new or related concepts that you mention here.
-->

### Example section about results
<!--
Tie it all together and briefly revisit the main key points and then the overall result/goal/importance
-->

## Further reading
<!--
Add any links to related resources that users might find useful.
What's the next step?
-->

## About the author
<!--
Add a short bio of yourself here
-->