Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Check the site https://redhatofficial.github.io first to ensure this project is
To add a new project we need:
- Project name
- Project description
- Link to the github repository
- Link to the GitHub repository
- Link to the project's website
- General category for this project

Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
Your updates should work in the following environments:

- [ ] Latest 2 versions of Edge
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
- [ ] Internet Explorer 11 (should be usable, not pixel perfect)
- [ ] Latest 2 versions of Firefox (one on macOS, one of Windows OS)
- [ ] Firefox 68 (or latest version for Red Hat Enterprise Linux distribution)
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
- [ ] Latest 2 versions of Chrome (one on macOS, one of Windows OS)
- [ ] Latest 2 versions of Safari
- [ ] Android mobile device (such as the Galaxy S9)
- [ ] Apple mobile device (such as the iPhone X)
Expand Down
88 changes: 39 additions & 49 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,43 @@
name: Validate build & urls
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- name: Checkout repository
uses: actions/checkout@v2
name: Build site

- name: Capture changed files
uses: jitterbit/get-changed-files@v1
id: files
with:
format: csv
token: ${{ secrets.GITHUB_TOKEN }}
on:
push:
branches: [ "dev" ]
pull_request:
types:
- opened
- reopened
- synchronize
- closed

- name: Cache node modules
uses: actions/cache@v2
env:
cache-name: cache-node-modules
with:
# npm cache files are stored in `~/.npm` on Linux/macOS
path: ~/.npm
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-build-${{ env.cache-name }}-
${{ runner.os }}-build-
${{ runner.os }}-
concurrency: preview-${{ github.ref }}

- name: Install dependencies
run: npm install
env:
CARGO_TERM_COLOR: always

- name: Backwards compatibility
run: |
mkdir -p dist
npm run babel

- name: Build
run: npm run build

- name: Validate URLs
# Only run this if these files were edited
if: contains(steps.files.outputs.added_modified, 'app/data/*.json')
uses: urlstechie/[email protected]
with:
# Only validate the files that were changed
include_files: ${{ steps.files.outputs.added_modified }}
sub_folder: app/data/
file_types: .json
timeout: 3
jobs:
build_and_deploy:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/dev'
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Build and deploy
uses: shalzz/[email protected]
env:
PAGES_BRANCH: gh-pages
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
preview:
runs-on: ubuntu-latest
if: github.ref != 'refs/heads/dev'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install and build
if: github.event.action != 'closed'
uses: shalzz/[email protected]
env:
BUILD_ONLY: true
BUILD_FLAGS: --drafts
BUILD_THEMES: false
CHECK_LINKS: true
56 changes: 0 additions & 56 deletions .github/workflows/pages.yml

This file was deleted.

47 changes: 37 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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 `/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:

```js
{
Expand All @@ -16,7 +16,8 @@ All projects are stored in the `/app/data` directory in the `projects.json` file
"projectWebsite": "http://foo.github.io",
"category": "Development",
"twitterHandle": "",
"twitterURL": ""
"twitterURL": "",
"lowercaseName": "foo project"
}
```

Expand Down Expand Up @@ -52,30 +53,56 @@ This list is just for Red Hat contributions to projects hosted on GitHub. See ht

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

## Quick start
## Changing the Featured list

To modify the featured projects, submit a pull request modifying the `/data/featured.json` file within the `dev` branch. You need to replace one of the featured projects rather than adding to the file.

In addition, you need to replace the logo in the `static/img` directory. The naming convention is important; you must name the image file as `logo-<logo>.png`, with `logo` here referencing the value in the `featured.json` file entry. So, for example, given the following entry:

```json
{
"name": "CentOS Project",
"logo": "centos",
"github": "https://github.com/CentOS",
"twitter": "https://twitter.com/CentOSProject",
"website": "https://www.centos.org/",
"description": "A solid, predictable base to build upon, with extensive resources to build, test, release, and maintain code."
}
```
The image would be `logo-centos.png`.

Upon review, the site maintainers will merge the PR or change the content as requested. No direct merges will be accepted.

## Contributing to the build

### Quick start

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

## Building and running locally
### 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](https://nodejs.org/) installed before you start.
To build and run this project in your local dev environment, first install [Zola](https://www.getzola.org/documentation/getting-started/installation/). Then, run

1. Install dependencies: `npm install`
2. Run the local development server: `npm start`
```bash
cd site
zola serve
```

The web page will start running on [localhost:8080](http://localhost:8080/).
Go to the URL for the webserver (likely `localhost:1111`) to explore the site.

## Built with

This site was created using [Angular](https://angularjs.org/), [webpack](https://webpack.js.org/), [NPM](https://www.npmjs.com/), [Babel](https://babeljs.io/), [Sass](https://sass-lang.com/), and [Netlify](https://www.netlify.com/).
This project is build and run using [Zola](https://www.getzola.org/), a Rust-based static site generator.

Under the hood, Zola uses [Tera](https://keats.github.io/tera/) for templating.

## Licensing

- [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) for the displayed page and primary license for this repository
- [MIT](https://opensource.org/licenses/MIT) for the JavaScript
- [MIT](https://opensource.org/licenses/MIT) for the small bits of Javascript within the HTML files
- [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.
5 changes: 0 additions & 5 deletions app/components/band/band.html

This file was deleted.

14 changes: 0 additions & 14 deletions app/components/band/band.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/components/bandheader/bandheader.html

This file was deleted.

14 changes: 0 additions & 14 deletions app/components/bandheader/bandheader.js

This file was deleted.

13 changes: 0 additions & 13 deletions app/components/bandheader/bandheader.scss

This file was deleted.

30 changes: 0 additions & 30 deletions app/components/card/card.html

This file was deleted.

13 changes: 0 additions & 13 deletions app/components/card/card.js

This file was deleted.

Loading