Skip to content

Commit

Permalink
Add the "how it works" demo video (#91)
Browse files Browse the repository at this point in the history
* Add the "how it works" demo video

* Fix dead links in the contributing md file
  • Loading branch information
javisperez committed Mar 11, 2024
1 parent d006e07 commit 9aff3a0
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -49,7 +49,7 @@ There are two aspects of code review: giving and receiving. To make it easier fo
* Write good commit messages
* Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue

Reviewers, the people giving the review, are highly encouraged to revisit our [Code of Conduct](./CODE_OF_CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community. When reviewing PRs from others [The Gentle Art of Patch Review](https://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with a pile of suggestions:
Reviewers, the people giving the review, are highly encouraged to revisit our [Code of Conduct](./CODE-OF-CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community. When reviewing PRs from others [The Gentle Art of Patch Review](https://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with a pile of suggestions:

1. Is the idea behind the contribution sound?
1. Is the contribution architected correctly?
Expand Down
7 changes: 6 additions & 1 deletion docs/.vitepress/config.mts
Expand Up @@ -127,5 +127,10 @@ export default defineConfig({
}
]
}
}
},

ignoreDeadLinks: [
'./CODE-OF-CONDUCT',
'./GOVERNANCE'
]
})
9 changes: 6 additions & 3 deletions docs/.vitepress/theme/components/Home.vue
Expand Up @@ -11,13 +11,16 @@ import { VueMarqueeSlider } from 'vue3-marquee-slider'
<a href="/docs/cli/installation" class="kit-button mt-10 md:mt-14 xl:mt-22">Install</a>
</div>

<div class="mt-32 md:mt-40 xl:mt-60 px-6 text-center max-w-[1152px] mx-auto">
<div id="howdoesitwork" class="mt-32 md:mt-40 xl:mt-60 px-6 text-center max-w-[1152px] mx-auto">
<h2>HoW does it WoRK<span class="font-heading font-extralight">?</span></h2>
<div class="p1 mt-8 mx-8">
Kit is an open source MLOps project that packages your model, datasets, code, and configuration so data scientists and developers can use their preferred tools while collaborating effortlessly.
</div>

<img src="/images/cli-screenshot.png" class="mt-22 mx-auto w-[1050px]" alt="screenshot of the kit cli tool" />
<video width="1050" autoplay controls muted loop class="max-w-full mt-22 mx-auto">
<source src="/how-it-works.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>

<div class="mt-32 md:mt-40 xl:mt-60 px-6">
Expand Down Expand Up @@ -75,7 +78,7 @@ import { VueMarqueeSlider } from 'vue3-marquee-slider'
</div>
</div>

<div class="mt-32 md:mt-40 xl:mt-60 px-6" id="howdoesitwork">
<div class="mt-32 md:mt-40 xl:mt-60 px-6">
<h2 class="text-center">Get stArted</h2>

<div class="kit-cards mt-22 min-h-[32.5rem]">
Expand Down
Binary file added docs/src/public/how-it-works.mp4
Binary file not shown.

0 comments on commit 9aff3a0

Please sign in to comment.