how-to

howto-faq.md

How To Edit the FAQ

Pre Reqs

You will need the following:

• Github Account
• Github Desktop
• Text Editor like: (I recommend atom if you don't have one)
• Atom: https://atom.io/
• vsCode: https://code.visualstudio.com/
• Brackets: http://brackets.io/

Setting up github Desktop

Connect your Github Desktop to your Github Account

Clone the FAQ Repo to your computer

1. Navigate to the Bandwidth FAQ Github Repo
2. Click the
3. Choose 'Open in Desktop'
4. The Github Desktop application should open the repo.

Choose where to save the files

Deside where the best place to save the files, in this case ~/Documents/faq

Create a new branch

Every time you want to make a change, you need to create a new branch Multiple questions can be added per branch, but after the changes have been accepted, you need to create a new branch

Adding questions and answers

Once you have your branch, it's time to make some changes!

Open the folder with the text editor

Using one of the text editors from the pre-reqs, open the folder from the saved location.

Add a new question

These are the general steps you'll used to add a new question

Update Summary.md

In Summary.md You can add a new TOPIC by adding ## Topic to a new line. You also need to create a new folder for each new topic. Existing topics already have their folder

Write new answer

Once the folder has been created, type out your new answer using markdown

Save the answer in the new folder

Update Summary.md with link to new answer

In the summary.md file, add the question title and the 'relative path' to the answer

## Demo Question
* [How can I add questions to the faq](demo-questions/demo-answer.md)

Commit changes

Once you're done making your changes, save everything and go back to github desktop.

We need to commit everything we did in github desktop

Review the changes

In github desktop, you can see the list of changes. Make sure they look right, and tick the [ ] check box.

Add commit message

In the field below the changes, type a breif description of your changes then click the Commit button

Changes are now committed

After you hit the commit button, the page will refresh and changes will be commited. You can click the buttons in the top right to see your history

Note

You can have as many commits as you need. Each commit is only stored locally and is just a way to save your work from a certain point in time.

Create Pull Request

Once everything is commited click the button.

You have the chance to add more information here if needed

Review on Github

Once you submit the PR it is live on Github and ready to review!

Files changed

You can see the files changed under the Files Changed tab