Changing or Adding Roadmaps and Tasks Content

Step 1 - Find the directory

Navigate to the correct place in the roadmap directory

View detailed info about folder structure

• If you're changing the info that would show up on a Task page, or adding a task that does not yet exist, choose tasks
• If you're adding or changing which tasks correspond to different situations (like "physical location" tasks), choose add-ons
• If the situation calls for changing an existing Task's default content for a certain case, choose modifications
• If you want to change the generic roadmap, choose generic

Step 2a - If changing a file

1. Click the file you want to change
2. Click the edit icon on the right side of the screen
3. Change the content or add new content to the file. Use the File Structure section below for reference.

Step 2b - If adding a new file

1. Start in the directory where the file should be added
2. Click the Add file button near the top right. Choose "Create new file"
3. Name your file. Use hyphens to separate words (no spaces allowed). If it's an Add-On or Modification: be descriptive about the situation in which it gets applied (ie, home-contractor) and end the name with the file format .json. If it's a task: The file name should be descriptive (you'll reference it in the add-ons section of the roadmap) and end the name with the file format .md.
4. Add your content. Make sure it matches the structure for the directory that the file exists in - see the File Structure section above.

Step 3 - Validating and saving changes

If editing JSON:

1. When you're done with the content, copy the entire file contents and visit this JSON validator site
2. Paste the file contents and click Validate JSON. If it's valid, you're good. If not, it will highlight the line with the problem. I've put together a cheatsheet for common JSON problems.
3. Visit this JSON prettifier site. Paste the valid JSON on the left and click "Make Pretty" in the middle of the screen. Replace your contents with the pretty-printed contents it generates on the right.

In all cases:

1. Make sure the content in the GitHub editor is the valid, pretty version. In the "Commit" box at the bottom, add some descriptive text to explain the change. If it's relevant to a story, put the number in brackets in the message. For example: Add new tax registration task [#55]
2. Click the green "Commit" button

File structure Quick Reference

Add-Ons

View detailed info

[
  {
    "step": <step number>,
    "weight": <number>,
    "task": "<task filename>"
  }
]

Modifications

View detailed info

[
  {
    "taskToReplaceFilename": "<task filename WITHOUT .md>",
    "replaceWithFilename": "<different task filename WITHOUT .md>"
  }
]

Tasks

View detailed info

---
id: "<task id (can be anything)>"
urlSlug: "<hyphenated-phrase (will show in user's browser)>"
name: "<user-facing task name>"
destinationText: "<optional user-facing destination for task>"
callToActionLink: "<optional destination URL of Call To Action button>"
callToActionText: "<optional custom call to action text for button>"
---

Task content here in markdown format

Finding IDs

Step ID Reference

Step 1 - Create a Business Plan id: create-business-plan

Step 2 - Due Diligence id: due-diligence

Step 3 - Form & Register Your Business id: register-business

Step 4 - Sign Your Lease and File Licenses & Local Permits id: lease-and-permits

Task Filenames

Visit the task directory and find the file that corresponds to the task you are referencing. Its filename is if you remove the .md part.

Notes

When editing Add-Ons and Modifications, ensure that the task filename and step ID are spelled correctly and exist.

When adding a new Add-On or Modification, let Anne know afterwords. It will need some additional code before it shows up in the application.

If you want to change the generic roadmap in steps.json:

• Changing text (ie, what a description or title says) can be done in the same change process as above
• Changing the structure (ie, adding or rearranging steps) - please talk to Anne about it first.