-
Notifications
You must be signed in to change notification settings - Fork 195
Adding an example
- Take a look at the template for an example page. Copy it if you need to.
- Familiarise yourself with the example page metadata and terminology.
Navigate to the _examples
folder at the top of this page.
Click on "Create new file" at the top right
You'll see an empty text area to paste your design principles into. At the top is a field for you to name your file. Give it a descriptive file name (for example here I'm adding the example "Design Well Inc's" design principles and have called the file design-well-in.md
)
![screenshot 2017-12-04 11 30 54](https://user-images.githubusercontent.com/362340/33551408-348d1744-d8e9-11e7-818d-83a4d307dc03.png)
Paste in your design principles. You'll need to format them based on a template which if you don't have it yet can be found here:
![screenshot 2017-12-04 11 36 07](https://user-images.githubusercontent.com/362340/33551412-372172c0-d8e9-11e7-83ac-3661db303560.png)
Scroll down to the bottom of the text area and 'Propose new file'. Give this a message, for example added example design-well-inc.md
![screenshot 2017-12-04 11 36 58](https://user-images.githubusercontent.com/362340/33551415-39128a6a-d8e9-11e7-8074-7c8ab3d6a958.png)
A pull request is something that's created for somebody to review your contribution and check everything is ok. If it's ok it will be merged into the site, if there's a problem somebody will fix it or let you know.
![screenshot 2017-12-04 11 37 21](https://user-images.githubusercontent.com/362340/33551422-3b685812-d8e9-11e7-89ea-67639e8f0893.png)
Give it a quick glance, make sure everything looks ok
![screenshot 2017-12-04 11 37 38](https://user-images.githubusercontent.com/362340/33551432-3e86e5f4-d8e9-11e7-93b6-0fd5ea9c5d65.png)
Once a pull request is made it will be reviewed and if everything is ok it'll be merged in and appear on the site. It may take a few days for this to happen.
Checkout the this repo and fire up jekyll (more instructions to follow in the next few days)