This is a running list of companies that are taking steps to address the spread of COVID-19. Pull requests gratefully accepted, especially around design or data formatting or correctness. If you are a journalist and would like to speak to someone about the list, email [email protected]. View the live website here: stayinghome.club.
The short version is: the website is generated from files in the _data
directory. Add the details of your
company by mimicking what others have done, and create a PR. If
you're not familiar with Git or Pull Requests, here are the steps.
You will need a Github account.
-
Make sure you're editing the main repository which hosts the website. It is here on Github:
https://github.com/phildini/stayinghomeclub
. -
You will need to create a YML file in the
companies
directory. Navigate there, and click the "Create new file" button. Here's a direct link to the Create page.Or, if you're just updating an existing entry, click on it, then hit the "Edit" button.
-
Give the file a name, something like
google.yml
orenvato.yml
ormy-awesome-company.yml
oring.yml
, no fancy or uppercase characters, and be sure to end it with .yml. Add the details about your company in this format:name: Your company name wfh: Strongly Encouraged travel: Restricted visitors: Restricted events: Restricted last_update: 2020-03-13
-
Click "Propose File Change", the big green button at the bottom of the page.
-
This will take you to a page where you can click "Create pull request". Once you do that, one of the maintainers of the website will attend to your update ASAP.
-
Thank you for helping us keep this site up-to-date! 🙏
You may want to run the site locally, to see what it looks like while you're making changes. A full tutorial is out of scope here, but these are the basic steps. We assume you know a little bit of Ruby.
First, you'll need Ruby Bundler, which manages this project's dependencies.
gem install bundler -v 2.1.4
Now, install the required Gems.
bundle install
When that's done, run the development server.
bundle exec jekyll serve
Jekyll will print a URL where you can see your local version running,
as it would on the web. Usually that's
http://127.0.0.1:4000/
.