Ch. 1 Overview - Convert to rST
Before you begin
The Salt community is so glad you are participating in the Feb. 10, 2021 Salt Docs Jam! A few things to be aware of:
- Overview: For this project, we're converting the Salt User Guide over to reStructured Text (rST). Read the guidelines for participating at the Salt User Guide Doc Jam (Feb 10).
- Prerequisites: Before working on this ticket, ensure you have first set up your environment for this repository. See our Contributing Guide for more information.
- Have you been assigned to this chapter? If you haven't already, check to make sure this is the chapter you were assigned to convert. We'll make assignments based on your interests and experience level with the tools. Your name should appear in next to this chapter on the Salt User Guide Chapter Spreadsheet after you've been officially assigned.
This chapter has the following files that need to be converted to rST:
- After you've forked and cloned the salt-user-guide repo, the file you are working on will be in docs > topics > overview.rst
- The source material you will need to convert is in the Chapter 1 Overview - Google Doc.
- For any images in this chapter, see the List of images. Find the image in this list and then copy the source code underneath the image to insert it into your chapter.
- After your merge request has been merged in, this file will appear on this page: Overview.
For help with the rST conversion:
- See our Writing Salt documentation - rST guide guide for information about how we want you to format the rST.
- You can also view our sample converted chapter: Salt grains. To view the rST for this chapter, you can view your copy of the repository or click Show Source on the bottom of the right navigation panel. To compare the rST version to the original Google Doc, see: Chapter 3 Salt grains.
When you're ready to submit a merge request
Before submitting your merge request, remember to:
- Install all the necessary prerequisites outlined in the Contributing Guide, such as Nox and pre-commit.
- Preview your files locally and compare them to the Google Doc chapter to ensure it matches the original formatting of the chapter.
- Use the docs_jam_merge_request template for your merge request and include a link to this ticket in your merge request.
- Use one of the three methods outlined in the Salt User Guide Doc Jam (Feb 10) to let us know that your merge request is ready for review.