Skip to content

Update README.md #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update README.md #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ We’ve put together a comprehensive list of the projects hosted on GitHub in wh

To add or modify projects to the list on [https://redhatofficial.github.io](https://redhatofficial.github.io), either submit a pull request or create an issue in the [repo](https://github.com/RedHatOfficial/RedHatOfficial.github.io). Upon review, the site maintainers will merge the PR or change the content as requested. No direct merges will be accepted.

All projects are stored in the `/app/data` directory in the `projects.json` file within the dev branch of this repo. Try to add your project alphabetically (just to make the file easier to search) and create a new object in the JSON that has:
All projects are stored in the `/app/data` directory in the `projects.json` file within the dev branch of this repo. Try to add your project alphabetically (just to make the file easier to search for) and create a new object in the JSON that has:

```js
{
"projectName": "Foo Project",
"project name": "Foo Project",
"projectDescription": "Lorem ipsum.",
"projectRepository": "https://github.com/foo",
"projectWebsite": "http://foo.github.io",
Expand All @@ -20,9 +20,9 @@ All projects are stored in the `/app/data` directory in the `projects.json` file
}
```

Be sure to include at _least_ the `projectName`, `projectRepository`, and `category`.
Be sure to include at least the `project name`, `project repository, and `category`.

Current categories include:
Current categories include

- Development
- Documentation
Expand All @@ -34,7 +34,7 @@ Current categories include:

### Criteria for adding projects to the page

At this time, only projects that Red Hat employees are required to work on as part of their job will be listed. This includes projects Red Hat stewards as well as projects in which Red Hat is just one contributor among others. For now, don't list sub-projects if at all possible. Eventually we will get to that, but for now, top-level projects only, please.
At this time, only projects that Red Hat employees are required to work on as part of their job will be listed. This includes projects Red Hat stewards as well as projects in which Red Hat is just one contributor among others. For now, don't list sub-projects if at all possible. Eventually, we will get to that, but for now, top-level projects only, please.

Please don't add projects for which you volunteer. There are so many amazing projects that Red Hatters work on as enthusiasts, ourselves included, but too many to recognize here.

Expand All @@ -46,16 +46,16 @@ Any project can appear in the Featured Projects section. To do so, the project m

### What about projects not on GitHub?

This list is just for Red Hat contributions to projects hosted on GitHub. See https://community.redhat.com/software/ for a more comprehensive listing of Red Hat's contributions to free and open source projects, regardless of where they are hosted.
This list is just for Red Hat contributions to projects hosted on GitHub. See https://community.redhat.com/software/ for a more comprehensive listing of Red Hat's contributions to free and open-source projects, regardless of where they are hosted.

### Hosting projects on /RedHatOfficial

Open an issue in _this_ repo, and the owners of the RedHatOfficial organization will get in touch with you.
Open an issue in _this_ repo, and the owners of the RedHat official organization will get in touch with you.

## Quick start
## Quickstart

```
git clone https://github.com/RedHatOfficial/RedHatOfficial.github.io.git
Git clone https://github.com/RedHatOfficial/RedHatOfficial.github.io.git
cd RedHatOfficial.github.io
```

Expand All @@ -66,7 +66,7 @@ To build and run this project in your local dev environment, follow the instruct
1. Install dependencies: `npm install`
2. Run the local development server: `npm start`

The web page will start running on [localhost:8080](http://localhost:8080/).
The web page will start running on [localhost: 8080](http://localhost: 8080/).

## Built with

Expand All @@ -78,4 +78,4 @@ This site was created using [Angular](https://angularjs.org/), [webpack](https:/
- [MIT](https://opensource.org/licenses/MIT) for the JavaScript
- [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/) for the HTML and CSS

Red Hat trademarks are not subject to the above license grants.
The Red Hat trademarks are not subject to the above license grants.