How to Edit Rules (Tina)
Before you start editing a rule, the first question to ask yourself is, why?
The rules exist to document solutions to recurring problems, if it's happened more than once, then it's probably worth making a rule.
Generally, every rule should document the reasons for adopting a specific solution, but not necessarily how to get there.
Making the changes is sooo much better than sending an email in the format of change x to y. It's fast, allows us to look at previous changes and gives you credits on your GitHub stats!
Better again is using the newly added Netlify CMS interface to edit rules without the hassle of worrying about branches, forks and pull requests. All of this is done automatically behind the scenes, and you still get all the benefits to your stats!
Figure: Some good GitHub stats 😄
Using the TinaCMS interface to edit rules is easy! Simply follow these steps:
- 🔐 You'll need permissions first 🔐 - Send an email to SysAdmins requesting Contributor access to the SSW.Rules project in Tina.io using Outlook | New Email | Content Chooser | All Staff Single Use Email Templates | Induction Part 2 - SSW Rules Tina Access
- After access is granted, navigate to the rule you want to edit on SSW Rules Beta.
- Click the pencil icon to open the TinaCMS editor.
Figure: Click to edit
- Use the editor in the left column to edit the details of the rule. You can preview your changes in the right column as you make them.
Important: You may need to switch to the tina-migration-main-content branch
Note: The actual content of the rule is in the Body field.
Figure: TinaCMS interface for a rule
- Tip: If you have substantially improved a rule, feel free to add yourself to the acknowledgements section.
See How-to-Add-an-Acknowledgment.
- Click 'Save' to save your changes to the rule. You will be asked to create a branch for your changes for approval before they are added to SSW Rules.
Figure: Create branch and save
-
Navigate to SSW.Rules.Content | Pull Requests and open your pull request. Add a title and fill out the description fields (As per Do you know how to write a good pull request?)
-
Once everything looks good, scroll down and click "Ready for review"
