Skip to content

Commit 9a6f556

Browse files
committed
Update contributing doc
1 parent 19b2334 commit 9a6f556

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

pages/docs/contributing/contributing-docs.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,29 @@ folder: releases
77

88
We (like almost all open source software providers) have a documentation dillemma... We tend to focus on the code features and functionality before working on documentation. And there is very good reason for this, we want to share the love so nobody feels left out!
99

10+
The following documentation page assumes one is running on OS X, but if you are not, you should be able to easily transpose the necessary commands to your operating system of choice.
1011

11-
## Setting up Development
12+
13+
## Setting Up Your Development Environment
14+
15+
### Installing Dependencies
16+
Initially (on OS X), you will need to setup [Brew](http://brew.sh/) which is a package manager for OS X and [Git](https://git-scm.com/). To install Brew and Git, run the following commands:
17+
18+
```bash
19+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
20+
brew install git
21+
```
1222

1323
### Fork the repo
14-
To contribute to the web based documentation, you should obtain a GitHub account and fork the <a href="https://www.github.com/singularityware/singularityware.github.io" target="_blank">Singularityware site</a> repository. Once forked, you will want to clone the fork of the repo to your computer. Let's say my Github username is vsoch, and I am using ssh:
24+
To contribute to the web based documentation, you should obtain a GitHub account and *fork* the <a href="https://www.github.com/singularityware/singularityware.github.io" target="_blank">Singularity GitHub Pages</a> repository by clicking the *fork* button on the top right of the page. Once forked, you will want to clone the fork of the repo to your computer. Let's say my Github username is *user99*:
1525

1626
```bash
17-
git clone git@github.com:vsoch/singularityware.github.io.git
27+
git clone https://github.com/user99/singularityware.github.io.git
1828
cd singularityware.github.io/
1929
```
2030

2131
### Install a local Jekyll server
22-
This step is required if you want to render your work locally before committing your changes. For the purpose of simplicity, we will articulate how to install Jekyll and its dependencies on a Mac.
32+
This step is required if you want to render your work locally before committing the changes. This is highly recommended to ensure that your changes will render properly and will be accepted.
2333

2434
```bash
2535
brew install ruby
@@ -34,8 +44,7 @@ Now you can see the site locally by running the server with jekyll:
3444
bundle exec jekyll serve
3545
```
3646

37-
This will make the site viewable at `http://localhost:4005/` If you want a nice look into how this works, you will probably want to look into the <a href="" target="_blank">config</a> file, or post a question to one of the <a href="/support" target="_blank">support places</a>.
38-
47+
This will make the site viewable at <a href="http://localhost:4005/" target="_blank">http://localhost:4005/</a>.
3948

4049
## Contributing a News Item
4150

0 commit comments

Comments
 (0)