An open API service indexing awesome lists of open source software.

https://github.com/ibm/ibm.github.io

IBM Open Source at GitHub
https://github.com/ibm/ibm.github.io

Last synced: 9 months ago
JSON representation

IBM Open Source at GitHub

Awesome Lists containing this project

README

          

# Portal for IBM @ GitHub

This repository is rendered online at [http://ibm.github.io](http://ibm.github.io), it contains a listing of repositories that are open source and maintained by IBM teams.

### Adding a new repo to the listing

In order to have your repository show up at [http://ibm.github.io](http://ibm.github.io), a minor change to [orgs.js](js/orgs.js) is required.

* To add a single repository add a new entry to [orgs.js](js/orgs.js), specify the Github organization name and the repository name (separate them with a `/`), and set the `type` to `repo`, an example can be seen below:

```
{
"name": "RuntimeTools/appmetrics",
"type": "repo"
}
```

* To add all the repositories in a Github organization add a new entry to [orgs.js](js/orgs.js), specify the Github organization name, and set the `type` to `org`, an example can be seen below:

```
{
"name": "IBMResilient",
"type": "org"
}
```

### To test changes locally

From within the top level folder of the cloned repository run:

```
$ python -m http.server {port}
```

For example: `python -m http.server 8000` -> Open the following URL in a browser:

```
http://localhost:8000/
```

### Quick Git tutorial

1. Clone the repository and checkout a new branch

```
$ git clone https://github.com/IBM/ibm.github.io
$ git checkout -b branch_name
```

2. Update the files you'd like to change
3. Push the changes upstream

```
$ git add file1 file2
$ git commit -m "add your commit message here"
$ git push origin branch_name
```

4. View your branch in Github and create a Pull Request