Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 4.04 KB

README.md

File metadata and controls

81 lines (52 loc) · 4.04 KB
Raw

Red Hat on GitHub

We’ve put together a comprehensive list of the projects hosted on GitHub in which Red Hat employees are actively involved. Given the large scope of our open source work, we recognize that we might have missed some projects or gotten a listing wrong. As time passes, more projects with which Red Hat employees collaborate will need to be added to the list. These circumstances, and others we can’t currently foresee, may mean you’ll want to make changes to this list. So, how do you do that?

Adding a project

To add or modify projects to the list on https://redhatofficial.github.io, either submit a pull request or create an issue in the repo. 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:

{
  "projectName": "Foo Project",
  "projectDescription": "Lorem ipsum.",
  "projectRepository": "https://github.com/foo",
  "projectWebsite": "http://foo.github.io",
  "category": "Development",
  "twitterHandle": "",
  "twitterURL": ""
}

Be sure to include at least the projectName, projectRepository, and category.

Current categories include:

  • Development
  • Documentation
  • Middleware
  • Operations
  • Organizations
  • Platform
  • Storage

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.

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.

These criteria may be subject to change as the page evolves.

Criteria for featured projects

Any project can appear in the Featured Projects section. To do so, the project must have a logo, as well as a straightforward and brief web description. Please submit your request as an ISSUE for this repo. No PRs, please, as updating the cards at this point in time involves changing multiple files.

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.

Hosting projects on /RedHatOfficial

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

Quick start

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

Building and running locally

To build and run this project in your local dev environment, follow the instructions below. Be sure you have Node.js installed before you start.

  1. Install dependencies: npm install
  2. Run the local development server: npm start

The web page will start running on localhost:8080.

Built with

This site was created using Angular, webpack, NPM, Babel, Sass, and Netlify.

Licensing

  • CC BY-SA 4.0 for the displayed page and primary license for this repository
  • MIT for the JavaScript
  • CC0 for the HTML and CSS

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