Skip to content

Commit

Permalink
Change site architecture to use Jekyll
Browse files Browse the repository at this point in the history
This removes Node.js as a dependency for building the site, and allows
standalone updates to the sites.json file to render to the site without
doing any building of HTML files.

To account for these differences, the CI build has changed to utilize
a mixture of Ruby packages/scripts and a single call to a NPM package
(via `npx`) to perform similar validations and linting.

Written in collaboration with PyroSamurai <pyrosamurai@member.fsf.org>

Closes #194
  • Loading branch information
Nightfirecat committed Apr 24, 2018
1 parent 80cf87c commit fdd9144
Show file tree
Hide file tree
Showing 164 changed files with 2,045 additions and 290,732 deletions.
8 changes: 2 additions & 6 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,9 @@ indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[{package{,-lock}.json,.travis.yml}]
[*.yml]
indent_size = 2

[_trans/*.json]
[*.md]
indent_size = 2
indent_style = tab

[*.html]
indent_style = tab
trim_trailing_whitespace = false
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
/node_modules
_site/
.sass-cache/
.jekyll-metadata
.bundle/
vendor/
25 changes: 13 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
language: node_js
node_js:
- "7"
before_script:
- npm install del
- npm install fs
- npm install gulp@3.9.1
- npm install gulp-data
- npm install gulp-jsonlint
- npm install gulp-rename
- npm install gulp-swig
script: gulp
language: ruby
rvm:
- 2.3.3

# Assume bundler is being used, therefore
# the `install` step will run `bundle install` by default.
script: ./script/cibuild

env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer

sudo: false
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,16 @@ The sites, urls and additional notes are stored in `sites.json`. If you want to
4. Any steps for the process should be detailed in the notes (if necessary).
5. Be sure to indent 4 spaces per level.
6. Be sure to place your entry ALPHABETICALLY in the current list.
7. Please test that your changes work validating `sites.json` with something like [JSON Lint](http://jsonlint.com/)
7. Please test that your changes work validating `sites.json` with something like [JSON Lint](http://jsonlint.com/) or the included "validate_json.rb" script

## Translation

If you want to translate the site:

1. Create a new `CODE.json` file in the `_trans/` directory where `CODE` is your [short country code](https://en.wikipedia.org/wiki/Country_code)
1. Create a new `CODE.json` file in the `_data/trans/` directory where `CODE` is your [short country code](https://en.wikipedia.org/wiki/Country_code)
2. Copy the contents of `en.json` to your new file
3. Translate each line
4. Within the `_pages/` directory, copy `_pages/index.html` to a new `CODE.html` file, and update the `lang: CODE` line to match the new page's code

### Style guide for Spanish Translations

Expand Down
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source "https://rubygems.org"

gem "jekyll"
gem "html-proofer"
98 changes: 98 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (5.2.0)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
colorize (0.8.1)
concurrent-ruby (1.0.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
ethon (0.11.0)
ffi (>= 1.3.0)
eventmachine (1.2.5)
eventmachine (1.2.5-x64-mingw32)
ffi (1.9.23)
ffi (1.9.23-x64-mingw32)
forwardable-extended (2.6.0)
html-proofer (3.8.0)
activesupport (>= 4.2, < 6.0)
addressable (~> 2.3)
colorize (~> 0.8)
mercenary (~> 0.3.2)
nokogiri (~> 1.8.1)
parallel (~> 1.3)
typhoeus (~> 1.3)
yell (~> 2.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.7.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (2.0.0)
listen (~> 3.0)
kramdown (1.16.2)
liquid (4.0.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.3.0)
minitest (5.11.3)
nokogiri (1.8.2)
mini_portile2 (~> 2.3.0)
nokogiri (1.8.2-x64-mingw32)
mini_portile2 (~> 2.3.0)
parallel (1.12.1)
pathutil (0.16.1)
forwardable-extended (~> 2.6)
public_suffix (3.0.2)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.1.1)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.5.6)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
thread_safe (0.3.6)
typhoeus (1.3.0)
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
yell (2.0.7)

PLATFORMS
ruby
x64-mingw32
x86_64-linux

DEPENDENCIES
html-proofer
jekyll

BUNDLED WITH
1.16.1
2 changes: 1 addition & 1 deletion LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013 Robb Lewis & various contributors
Copyright (c) 2013-2017 Robb Lewis, The JDM Contrib Team, & various contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
54 changes: 29 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,58 @@
JustDeleteMe
=============
============

A directory of direct links to delete your account from web services.

[![Build Status](https://travis-ci.org/jdm-contrib/justdelete.me.svg?branch=master)](https://travis-ci.org/jdm-contrib/justdelete.me)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/53bbffc9bd3c40459200b33736922c6b)](https://www.codacy.com/app/tupaschoal/justdelete-me?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jdm-contrib/justdelete.me&amp;utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/53bbffc9bd3c40459200b33736922c6b)](https://www.codacy.com/app/tupaschoal/justdelete-me)

# Building
## Building Locally

The site's HTML page is periodically built and checked in, so `/docs/*.html` should be working copies of the site at any given time. To update these pages with new sites or HTML templates, follow along below.
JustDeleteMe is built using [Jekyll](https://jekyllrb.com/) and is linted and
validated using a mixture of Ruby and Node.js packages and scripts.

**Dependencies:**

* [Node.js](https://nodejs.org/en/) ([requires >=v7](https://nodejs.org/en/download/current/))
- [Ruby](https://www.ruby-lang.org) (>=2.3.3)
- [Node.js](https://nodejs.org)

**Installation**

* Clone the repository:
- Clone the repository

```
git clone https://github.com/jdm-contrib/justdelete.me.git
```
```
git clone https://github.com/jdm-contrib/justdelete.me.git
```

* Install `npm` within your local repository
- Install dependencies

```
cd justdelete.me
npm install
```
```
cd justdelete.me
gem install bundler
bundler install
```

* Run `gulp`
**Building the site**

```
gulp
```
Just run `jekyll serve`

# Contributing
**Testing**

If you want to help, do read our [contributing](https://github.com/jdm-contrib/justdelete.me/blob/master/CONTRIBUTING.md) guidelines.
Tests are run via the "cibuild" script, and can be run via `./script/cibuild`

# Misc
## Contributing

If you want to help, do read our [contributing](CONTRIBUTING.md) guidelines.

## Misc

Search functionality modified from [DevCenter.me](https://github.com/stevestreza/DevCenter.me).

## License

Licensed under the MIT License (MIT).
Copyright (c) 2013 Robb Lewis, various contributors.
See `LICENSE.md`.
Licensed under the MIT License (MIT). See `LICENSE`.

Country Flag Icons Copyright (c) 2013 Go Squared Ltd. http://www.gosquared.com/

This is a detached fork of the original repo that intends to keep the project alive, as the original one was abandoned.
This is a detached fork of the original repo that intends to keep the project
alive, as the original one was abandoned.
5 changes: 5 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
exclude: [CONTRIBUTING.md, Gemfile, Gemfile.lock, LICENSE, README.md, script, vendor]
collections:
pages:
output: true
permalink: /:categories/:title:output_ext
File renamed without changes.
41 changes: 41 additions & 0 deletions _data/trans/ar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"banner":"إمتداد كروم",
"description": "Just Delete Me | دليل وصلات لحذف حساباتك من المواقع التفاعلية. تعرف على كيفية حذف حساباتيكم على الفايسبوك, تويتر و لينكداين وأكثر.",
"difficulty":"الصعوبة",
"difficulty_easy":"سهل",
"difficulty_hard":"صعب",
"difficulty_impossible":"مستحيل",
"difficulty_medium":"متوسط",
"extension":"امتداد من آجل جوجل كروم",
"extensionguide":"دليل الامتداد",
"extensionl1":"<span class=\"dot-wrapper\"><span class=\"dot easy\"></span></span> - عملية بسيطة",
"extensionl2":"<span class=\"dot-wrapper\"><span class=\"dot medium\"></span></span> - تحتاج مراحل إضافية",
"extensionl3":"<span class=\"dot-wrapper\"><span class=\"dot hard\"></span></span> - لا يمكن حذفه بصفة نهائية إلا عند الاتصال بالدعم",
"extensionl4":"<span class=\"dot-wrapper\"><span class=\"dot impossible\"></span></span> - لا يمكن حذفه",
"extensionp1":"صديقنا<a target=\"_blank\" href=\"http://mikerogers.io\">مايك روجرز</a> ساعدنا في إنشاء إمتداد جوجل كروم ل JustDeleteMe",
"extensionp2":"عند الدخول لأحد المواقع المعروضة في موقعنا، سيتم إضافة علامة مميزة في شريط العنوان. بالضغظ عليه سيحولك مباشرة إلى صفحة الحذف داخل الموقع المتصفح",
"extensionp3":"للثتبيث من هنا <a target=\"_blank\" href=\"https://chrome.google.com/webstore/detail/justdeleteme/hfpofkfbabpbbmchmiekfnlcgaedbgcf\">Chrome Web Store</a>.",
"guide":"الدليل",
"guideeasy":"<span class=\"difficulty\">سهل</span> - عملية سهلة",
"guideexplanations":"الرصلات ملونة لتعلم المتصفح بمستوى صعوبة حذف حسابك في المواقع المدرجة",
"guidehard":"<span class=\"difficulty\">صعب</span> - لا يمكن مسحه بصفة نهائية حتى تتصل بدعم الموقع",
"guideimpossible":"<span class=\"difficulty\">مستحيل</span> - لا يمكن حذفه",
"guidemedium":"<span class=\"difficulty\">متوسط</span> - تحتاج مراحل إضافية",
"help":"ساعد في الترجمة",
"hideinfo":"حجب العلومات...",
"morecontrib":"المزيد من المساهمين",
"name": "العربية",
"noinfo":"معلومات غير متاحة",
"popular": "Popular",
"sendmail":"إرسال رسالة",
"showinfo":"شاهد المعلومات...",
"submit":"إدراج موقع",
"tagline":"دليل وصلات لحذف حساباتك من المواقع التفاعلية" ,
"title": "Just Delete Me | دليل وصلات مباشرة لحذف حساباتك من المواقع التفاعلية.",
"translationcontrib":"المساهمون في الترجمة",
"viewcontrib":"آنظر كافة المشاركين",
"whatisthis":"ما هذا ؟",
"whatisthis1":" مجموعة من المواقع تستعمل تقنيات تسمى <a href=\"http://darkpatterns.org/\">dark pattern</a> لتصعب عملية حذف الحساب الخاص بك. JustDeleteMe يريد ان يصبح دليلا لوصلات تسهل عملية الحذف.",
"whatisthis2":"هل تعتقد آن هنالك موقع يجب اضافته ؟ <a href=\"https://github.com/jdm-contrib/justdelete.me\"> تابع المشروع على جيت هاب</a>",
"whatisthis3":" الإضافة بواسطة البريد معطلة مؤقتا"
}
41 changes: 41 additions & 0 deletions _data/trans/cat.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"banner": "Prova la nostra nova <span>Extensió de Chrome</span>",
"description": "Un directori d'enllaços per eliminar els teus comptes dels diferents serveis d'internet. Descobreix com eliminar els comptes de Facebook, Twitter i altres.",
"difficulty": "dificultat",
"difficulty_easy": "fàcil",
"difficulty_hard": "difícil",
"difficulty_impossible": "impossible",
"difficulty_medium": "mitja",
"extension": "Extensió per a Google Chrome",
"extensionguide": "Guia del Punt de l'extensió",
"extensionl1": "<span class=\"dot-wrapper\"><span class=\"dot easy\"></span></span> - Procés simple",
"extensionl2": "<span class=\"dot-wrapper\"><span class=\"dot medium\"></span></span> - S'han de fer alguns passos extra",
"extensionl3": "<span class=\"dot-wrapper\"><span class=\"dot hard\"></span></span> - No es pot suprimir permanentment sense contactar amb atenció al client",
"extensionl4": "<span class=\"dot-wrapper\"><span class=\"dot impossible\"></span></span> - No pot ser suprimida",
"extensionp1": "El nostre amic <a target=\"_blank\" href=\"http://mikerogers.io\">Mike Rogers</a> ens ha ajudat a llançar aquesta increible Extensió de Google Chrome per a JustDeleteMe.",
"extensionp2": "Si entres a una web identificada per JustDeleteMe, l'extensió et mostrarà un punt a l'omnibar. Clicant a aquell punt, et portarà directament a la pàgina per esborrar el compte.",
"extensionp3": "Per instal·lar-la, entra a la <a target=\"_blank\" href=\"https://chrome.google.com/webstore/detail/justdeleteme/hfpofkfbabpbbmchmiekfnlcgaedbgcf\">Chrome Web Store</a>.",
"guide": "Guia",
"guideeasy": "<span class=\"difficulty\">Fàcil</span> - Procés simple",
"guideexplanations": "Els enllaços de la part superior s'han classificat amb un codi de colors per indicar la dificultat per suprimir el compte:",
"guidehard": "<span class=\"difficulty\">Difícil</span> - No es pot suprimir permanentment sense contactar amb atenció al client",
"guideimpossible": "<span class=\"difficulty\">Impossíble</span> - No pot ser suprimida",
"guidemedium": "<span class=\"difficulty\">Mitja</span> - S'han de fer alguns passos extra",
"help": "Ajuda a traduir",
"hideinfo": "amagar informació",
"morecontrib": "Més col·laboradors",
"name": "Català",
"noinfo": "No hi ha informació disponible",
"popular": "Popular",
"sendmail": "Envia un e-mail",
"showinfo": "mostrar informació",
"submit": "Submit a site",
"tagline": "Un directori d'enllaços directes per suprimir els seus comptes de la web.",
"title": "Just Delete Me | Un directori d'enllaços directes per eliminar els teus comptes dels diferents serveis d'internet.",
"translationcontrib": "Traductors col·laboradors",
"viewcontrib": "Veure tots els col·laboradors",
"whatisthis": "Que es això?",
"whatisthis1": "Nombroses companyies usen una técnica anomenada <a href=\"http://darkpatterns.org/\">dark pattern</a> per dificultar l'eliminació dels comptes d'usuari als seus serveis online. JustDeleteMe busca ser un directori on centralitzar els enllaços per eliminar facilment les vostres comptes de la web.",
"whatisthis2": "Creus que es podría posar algun altre servei web a la llista? <a href=\"https://github.com/jdm-contrib/justdelete.me\">Fes un Fork del projecte a GitHub.</a>",
"whatisthis3": "<em>El servei de captació d'emails està temporalment inhabilitat</em>"
}
41 changes: 41 additions & 0 deletions _data/trans/de.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"banner": "Testen Sie unsere neue <span>Chrome Erweiterung</span>",
"description": "Ein Verzeichnis direkter Links zur Löschung deines Accounts aus verschiedenen Webdiensten wie beispielsweise Facebook, Twitter, LinkedIn, ...",
"difficulty": "Schwierigkeit",
"difficulty_easy": "leicht",
"difficulty_hard": "schwer",
"difficulty_impossible": "unmöglich",
"difficulty_medium": "mittel",
"extension": "Google Chrome-Erweiterung",
"extensionguide": "Punkte-Anleitung der Erweiterung",
"extensionl1": "<span class=\"dot-wrapper\"><span class=\"dot easy\"></span></span> - Einfacher Prozess",
"extensionl2": "<span class=\"dot-wrapper\"><span class=\"dot medium\"></span></span> - Einige zusätzliche Schritte sind nötig",
"extensionl3": "<span class=\"dot-wrapper\"><span class=\"dot hard\"></span></span> - Kann nicht vollständig gelöscht werden, ohne den jeweiligen Support zu kontaktieren",
"extensionl4": "<span class=\"dot-wrapper\"><span class=\"dot impossible\"></span></span> - Kann nicht gelöscht werden",
"extensionp1": "Unser Freund <a target=\"_blank\" href=\"http://mikerogers.io\">Mike Rogers</a> hat uns geholfen, eine großartige Google Chrome-Erweiterung für JustDeleteMe zu erstellen.",
"extensionp2": "Wenn Sie auf einer Seite sind, die auf JustDeleteMe gelistet ist, fügt die Google Chrome-Erweiterung einen kleinen Punkt zur Omnibar hinzu. Ein Klick auf diesen Punkt befördert Sie zur relevanten Löschen-Seite.",
"extensionp3": "Um die Erweiterung zu installieren, rufen Sie einfach den <a target=\"_blank\" href=\"https://chrome.google.com/webstore/detail/justdeleteme/hfpofkfbabpbbmchmiekfnlcgaedbgcf\">Chrome Web Store</a> auf.",
"guide": "Anleitung",
"guideeasy": "<span class=\"difficulty\">Leicht</span> - Einfacher Prozess",
"guideexplanations": "Die Links oben sind farbkodiert, um die Schwierigkeit des Account-Löschens anzuzeigen:",
"guidehard": "<span class=\"difficulty\">Schwer</span> - Kann nicht gelöscht werden, ohne den jeweiligen Support zu kontaktieren",
"guideimpossible": "<span class=\"difficulty\">Unmöglich</span> - Kann nicht gelöscht werden",
"guidemedium": "<span class=\"difficulty\">Mittel</span> - Einige zusätzliche Schritte sind notwendig",
"help": "Hilf uns bei der Übersetzung",
"hideinfo": "verstecke Info...",
"morecontrib": "Weitere Unterstützer",
"name": "Deutsch",
"noinfo": "Keine Information verfügbar.",
"popular": "Beliebt",
"sendmail": "E-Mail senden",
"showinfo": "zeige Info...",
"submit": "Seite eintragen",
"tagline": "Ein Verzeichnis direkter Links um deinen Account aus Webdiensten zu löschen",
"title": "Just Delete Me | Ein Verzeichnis direkter Links zur Löschung deines Accounts aus verschiedenen Webdiensten.",
"translationcontrib": "Übersetzungshelfer",
"viewcontrib": "Alle Unterstützer",
"whatisthis": "Was ist das?",
"whatisthis1": "Viele Firmen nutzen <a href=\"http://darkpatterns.org/\">dark pattern</a>-Techniken, um es schwierig zu machen, deinen Account zu löschen. Das Ziel von JustDeleteMe ist ein Verzeichnis von URLs, damit Sie Ihr Konto bei verschiedenen Webdiensten einfach löschen können.",
"whatisthis2": "Fehlt eine Seite, die hinzugefügt werden sollte? <a href=\"https://github.com/jdm-contrib/justdelete.me\">Forke das Projekt auf GitHub</a>.",
"whatisthis3": "<em>E-Mail-Vorschläge sind zur Zeit deaktiviert</em>"
}
Loading

0 comments on commit fdd9144

Please sign in to comment.