Skip to content

Commit

Permalink
Remove (old) website source files (simple-icons#5553)
Browse files Browse the repository at this point in the history
* Remove files directly related to the website

Remove all the files directly related to the Jekyll-based website in
this repository. This includes the HTML, CSS and JS for the website, the
assets that can be found in the images/ folder, Jekyll-related files
(_config.yml, Gemfile, Gemfile.lock) and the CNAME file.

* Remove website-related configurations

Remove website-related files from ignore files, update the EditorConfig
configuration to remove any mention of website files, and update
.gitattributes to omit removed files.

* Update issue templates

Remove the issue templates for issues regarding the website and replace
it with a issue templates configuration file [1] that provides a link to
a the equivalent issue template in the simple-icons-website repository.

--
1. https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository


* Remove building website from verify workflow

* Remove mentions of website from Contributing Guidelines

* Remove mention of GitPod

I believe the main advantage of GitPod was that it allows you to preview
a contribution in the context of the website. Now that the website is no
longer in the repository this is not a thing anymore (unless someone
can configure GitPod to pull in the website from its repo), so I removed
any mention of it.

I'm open to reverting this change if contributors still want to use
GitPod.

* Add CI job for building the NodeJS package
  • Loading branch information
ericcornelissen authored May 29, 2021
1 parent c15eb68 commit c368b14
Show file tree
Hide file tree
Showing 21 changed files with 38 additions and 1,121 deletions.
6 changes: 0 additions & 6 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
node_modules/
npm-debug.log

# Jekyll
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata

# Build files
icons/*.js
/index.js
3 changes: 0 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,3 @@ trim_trailing_whitespace=false # Templates with trailing whitespace are more usa

[_data/simple-icons.json]
indent_size=4

[index.html]
indent_size=4
7 changes: 0 additions & 7 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@

# Don't diff machine generated files
package-lock.json -diff
Gemfile.lock -diff
slugs.md -diff

# Treat images as binary
*.ico binary
*.png binary

# Don't export/archive these files
.github export-ignore
.gitpod.yml export-ignore
CNAME export-ignore
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Website
about: Issues and improvements for the website
url: https://github.com/simple-icons/simple-icons-website/issues/new?assignees=&labels=&template=website.md
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/website.md

This file was deleted.

28 changes: 14 additions & 14 deletions .github/workflows/verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@ name: Verify Source
on: [pull_request, push]

jobs:
build:
name: Build package
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Use Node.js 12.x
uses: actions/setup-node@v2
with:
node-version: 12.x
- name: Install dependencies
run: npm ci
- name: Build NodeJS package
run: npm run build
lint:
name: Lint
runs-on: ubuntu-latest
Expand All @@ -20,20 +34,6 @@ jobs:
npm run svglint
npm run wslint
npm run our-lint
build:
name: Build website
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Use Ruby 2.7
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
# https://github.com/ruby/setup-ruby/blob/master/README.md#caching-bundle-install-automatically
bundler-cache: true
- name: Build website
run: bundle exec jekyll build
test:
name: Test package
runs-on: ubuntu-latest
Expand Down
44 changes: 20 additions & 24 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# Created by https://www.gitignore.io/api/macos,jekyll
# Files generated by build script
/index.js

# Ignore all files in the icons folder
icons/*
# Except SVG files
!icons/*.svg


### NodeJS ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Dependency directories
node_modules/

### Jekyll ###
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata

### macOS ###
# General
Expand Down Expand Up @@ -33,21 +47,3 @@ Icon
Network Trash Folder
Temporary Items
.apdisk

# End of https://www.gitignore.io/api/macos,jekyll


# NPM dependencies
node_modules/

### Ruby ###
/.bundle/
/vendor/bundle

# Files generated by build script
/index.js

# Ignore all files in the icons folder
icons/*
# Except SVG files
!icons/*.svg
7 changes: 0 additions & 7 deletions .gitpod.yml

This file was deleted.

1 change: 0 additions & 1 deletion CNAME

This file was deleted.

31 changes: 0 additions & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Simple Icons welcomes contributions and corrections. Before contributing, please

* [Requesting an Icon](#requesting-an-icon)
* [Adding or Updating an Icon](#adding-or-updating-an-icon)
* [Building the Website](#building-locally)
* [Using Docker](#using-docker)

## Requesting an Icon
Expand Down Expand Up @@ -358,28 +357,13 @@ Once you've completed the previous steps, create a pull request to merge your ed

If you have an affiliation to the brand you contributing that allows you to speak on their behalf then please disclose that in your pull request as it can help speed up our research and review processes.

## Building Website Locally

* Make sure you have [Ruby](https://www.ruby-lang.org/en/downloads/) installed.
* Make sure you have [Bundler](https://bundler.io/) installed (using `$ gem install bundler`).
* Set your local gems installation location for the simple-icons website using `$ bundle config set path 'vendor/bundle'`.
* Install dependencies using `$ bundle install`.
* Build and run the website locally using `$ bundle exec jekyll serve`.
* Connect to the website in your browser via the "Server address" provided by the output of this command, e.g. `http://localhost:4000/`

## Testing Package Locally

* Make sure you have [NodeJS](https://nodejs.org/en/download/) installed. At least version 12.4.0 is required.
* Install the dependencies using `$ npm install`.
* Build and test the package using `$ npm test`.
* Run the project linting process using `$ npm run lint`.

## Building in Your Browser

Alternatively, you can build and run the website in a readily configured online workspace:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/simple-icons/simple-icons)

## Using Docker

You can build a Docker image for this project from the Dockerfile by running:
Expand All @@ -392,21 +376,6 @@ $ docker build . -t simple-icons
$ docker run -it --rm --entrypoint "/bin/ash" simple-icons
```

### Jekyll Server using Docker

To use a Docker container to run the Jekyll server for the website, run:

```bash
# Start a container running `jekyll serve` in the background
$ docker run -d -p 4000:4000 --rm --volume $PWD:/srv/jekyll --name simple-icons-server jekyll/jekyll jekyll serve

# Inspect the server logs
$ docker logs simple-icons-server

# Stop the server (and delete the container)
$ docker stop simple-icons-server
```

---

# Versioning
Expand Down
7 changes: 0 additions & 7 deletions Gemfile

This file was deleted.

68 changes: 0 additions & 68 deletions Gemfile.lock

This file was deleted.

10 changes: 0 additions & 10 deletions _config.yml

This file was deleted.

Binary file removed images/apple-touch-icon.png
Binary file not shown.
Binary file removed images/favicon.ico
Binary file not shown.
Binary file removed images/favicon.png
Binary file not shown.
1 change: 0 additions & 1 deletion images/logo.svg

This file was deleted.

Binary file removed images/og.png
Binary file not shown.
Loading

0 comments on commit c368b14

Please sign in to comment.