-
Notifications
You must be signed in to change notification settings - Fork 53
Write a New Tutorial
The H2O.ai community has provided a format to follow, and a corresponding template to use, when writing tutorials. This ensures that the tutorial is clear, orderly, and that readers are able to follow along smoothly.
- Have experience with Markdown. If you are new to Markdown, visit Appendix A: New to Markdown
- Be familiar with Contributing Tutorial Updates
- Create a New Issue
- Creating a New Tutorial
- Naming and Placing Your Tutorial
- Review and Make a Pull Request
- Appendix A : New to Markdown
So that the community can provide some feedback, it's a good idea to create a new issue and outline the tutorial you will be working on and what will be covered.
Include the following on your new issue message:
**Tutorial name**: <Add tutorial name here>
**H2O.ai Product**: <Driverless AI, H2O-3, etc.>
**Link to tutorial**: <Either a H2O.ai link or GitHub link works fine>
### Description of issue:
### Proposed fix (if any):
As a jumping off point, the community has put together a tutorial template. You can also find it in your forked repository under the directory path /tutorials/templates/tutorial-template.
The template includes stubs and explanations of required sections as well as snippets of common Markdown you can use. Feel free to copy this template and use it as a starting point for your new tutorial.
Your tutorial folder will look like this:
|-- name-of-your-tutorial/
|-- name-of-your-tutorial.md
|-- assets/
|-- your-images-here.jpg
|-- your-files-here.txt
Now that you have a tutorial created, let's correctly name your folder and place it in the right location in the repository.
Your tutorial folder should be all lowercase, with spaces replaced with dashes and no special characters included.
Example: A tutorial titled "Automatic Machine Learning with Driverless AI" would have its folder named "automatic-machine-learning-with-driverless-ai"
After you name your folder, you'll want to place it in the right location in the repository. Place it in the folder of the product and version for which it was written. For example, if the tutorial was written for DAI version 1.7.0, place it in h2oai/tutorials/tree/master/DriverlessAI.
Before making a pull request and getting your tutorial merged into the repository, make sure that you satisfy this contributor checklist:
- Issue created, outlining the tutorial that you're creating
- All tutorial assets (images, files, etc.) stored in the tutorials' assets folder
- Checked for typos, broken links, missing images in the tutorial
- You've successfully tested the tutorial
- Github issue referenced in your pull request
For reference material and getting up to speed with Markdown, visit Mastering Markdown