extras
/
cheatsheets
mirror of https://github.com/rstacruz/cheatsheets.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cheatsheets/CONTRIBUTING.md

182 lines
4.6 KiB
Markdown
Raw Permalink Normal View History

Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
# Developer notes
Update dependencies, Ruby, Node (#2099) * Update deps * Update GitHub actions * Update netlify runtimes * Add csv * Downgrade to Ruby 3.2.3
2024-02-04 11:35:55 +00:00
## Runtimes
Requires Node.js, Ruby, Yarn v1.
See `.ruby-version` and `.node-version` for supported versions.
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
## Gitpod
gitpod: deploy Disclaimer: i'm not gitpod staff i just like their product Proposing to integrate gitpod with this repository which is online IDE based on Theia which allows contributors to open an online environment without the need to fetch deps on their local system. This service is free for open-source repositories. Example of the runtime: https://gitpod.io/#https://github.com/RXT067/cheatsheets/tree/gitpod Signed-off-by: Jacob Hrbek <kreyren@rixotstudio.cz>
2019-12-13 22:45:47 +00:00
This repository supports contribution using [gitpod](https://gitpod.io) which is online IDE using [Theia](https://github.com/eclipse-theia/theia).
To open-up the environment simple natigate on https://gitpod.io/#https://github.com/rstacruz/cheatsheets
Or using a button:<br>
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/rstacruz/cheatsheets)
### Preview built website
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
gitpod: deploy Disclaimer: i'm not gitpod staff i just like their product Proposing to integrate gitpod with this repository which is online IDE based on Theia which allows contributors to open an online environment without the need to fetch deps on their local system. This service is free for open-source repositories. Example of the runtime: https://gitpod.io/#https://github.com/RXT067/cheatsheets/tree/gitpod Signed-off-by: Jacob Hrbek <kreyren@rixotstudio.cz>
2019-12-13 22:45:47 +00:00
To preview the website you need to first build it then you can navigate to file that you are trying to contribute and preview directly.
Major rewrite (!) (#2130)
2024-03-28 08:59:22 +00:00
<img src='.github/images/gitpod_preview_tut.png' width=828 height=459/>
gitpod: deploy Disclaimer: i'm not gitpod staff i just like their product Proposing to integrate gitpod with this repository which is online IDE based on Theia which allows contributors to open an online environment without the need to fetch deps on their local system. This service is free for open-source repositories. Example of the runtime: https://gitpod.io/#https://github.com/RXT067/cheatsheets/tree/gitpod Signed-off-by: Jacob Hrbek <kreyren@rixotstudio.cz>
2019-12-13 22:45:47 +00:00
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
## Starting a local instance
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
This starts Jekyll and Parcel. This requires recent versions of [Node.js], [Yarn], [Ruby] and [Bundler] installed.
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
Add Docker support
2018-06-26 23:10:51 +00:00
```bash
Use 'yarn run dev' for everything
2017-10-01 21:59:44 +00:00
yarn install
bundle install
env PORT=4001 yarn run dev
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
```
Add Docker support
2018-06-26 23:10:51 +00:00
[node.js]: https://nodejs.org/en/download/package-manager/
[ruby]: https://www.ruby-lang.org/en/documentation/installation/
[yarn]: https://yarnpkg.com/en/docs/install
[bundler]: https://bundler.io/
### Docker
You can also run a local instance using Docker. This is the preferred method, especially for Windows.
You only need to install Docker ([macOS](https://docs.docker.com/docker-for-mac/install/), [Windows](https://docs.docker.com/docker-for-windows/install/), [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/), [Arch Linux](https://www.archlinux.org/packages/community/x86_64/docker/), [other](https://www.docker.com/community-edition#download)).
First time setup:
Windows quickstart tutorial on CONTRIBUTING.md Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
2017-12-21 04:33:07 +00:00
```bash
Add Docker support
2018-06-26 23:10:51 +00:00
# Build images (takes ~12mins)
docker-compose build
Windows quickstart tutorial on CONTRIBUTING.md Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
2017-12-21 04:33:07 +00:00
Add Docker support
2018-06-26 23:10:51 +00:00
# First-time setup
fix command First-time setup docker
2020-06-09 06:11:18 +00:00
docker-compose run --rm web bundle install && docker-compose run --rm web yarn install
Add Docker support
2018-06-26 23:10:51 +00:00
```
Windows quickstart tutorial on CONTRIBUTING.md Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
2017-12-21 04:33:07 +00:00
Add Docker support
2018-06-26 23:10:51 +00:00
Starting the server:
Windows quickstart tutorial on CONTRIBUTING.md Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
2017-12-21 04:33:07 +00:00
```bash
Add Docker support
2018-06-26 23:10:51 +00:00
docker-compose up
Windows quickstart tutorial on CONTRIBUTING.md Developer notes::Starting a local instance ### Windows 1. Install **Ruby**: https://rubyinstaller.org/ * After the installation check the box and type `3` to select the 3rd option * Add `C:\msys64\usr\bin` to PATH env variable * Add `C:\Ruby24-x64\bin` to PATH env variable 2. Install **yarn**: https://yarnpkg.com/en/docs/install#windows 3. Install **jekyll** via command prompt: `gem install jekyll bundler` 4. Install **nodejs && npm**: https://nodejs.org/en/download/ 4. Install **webpack** via command prompt: `npm install -g webpack` 5. If you have any issues after installing ruby, like `HOMEPATH` is not defined, then execute the below commands: ```bash SETX HOMEDRIVE %SYSTEMDRIVE% -m SETX HOMEPATH \Users\%username% -m SET HOME=%SYSTEMDRIVE%\Users\%USERNAME% SETX HOME "%HOME%" ``` #### Start Jekyll and Webpack Go wherever the project's files are located and open a new command prompt, execute the below commands: ```bash yarn install bundle install SET PORT=4001 yarn run dev ```
2017-12-21 04:33:07 +00:00
```
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
## CSS classes
Update URLs
2017-09-23 19:40:38 +00:00
See <https://devhints.io/cheatsheet-styles> for a reference on styling.
101: big update
2017-09-21 08:25:42 +00:00
Add some tests
2017-10-01 20:57:41 +00:00
## JavaScript
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
When updating JavaScript, be sure Parcel is running (`yarn dev` takes care of this).
Add some tests
2017-10-01 20:57:41 +00:00
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
This auto-updates `/assets/packed/` and `_includes/2017/critical/` with sources in `_parcel/`.
Before committing, run `yarn parcel:build` first.
Add some tests
2017-10-01 20:57:41 +00:00
Use 'yarn run dev' for everything
2017-10-01 21:59:44 +00:00
## JavaScript tests
Add some tests
2017-10-01 20:57:41 +00:00
There are also automated tests:
```
yarn run test --watch
```
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
## Frontmatter
Each sheet supports these metadata:
```yml
---
title: React.js
# Optional:
category: React
Cleanup: update timestamps of files
2020-07-04 13:33:09 +00:00
updated: 2020-06-14
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
ads: false # Add this to disable ads
weight: -5 # lower number = higher in related posts list
deprecated: true # Don't show in related posts
deprecated_by: /enzyme # Point to latest version
prism_languages: [vim] # Extra syntax highlighting
camp: add cheatsheet for node.js web server framework
2017-09-21 07:59:20 +00:00
intro: |
This is some *Markdown* at the beginning of the article.
Implement 'type' metadata
2017-09-04 02:23:45 +00:00
tags:
- WIP
- Featured
# Special pages:
# (don't set these for cheatsheets)
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
type: home # home | article | error
og_type: website # opengraph type
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
---
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
```
## Prism languages
For supported prism languages:
- <https://github.com/PrismJS/prism/tree/gh-pages/components>
## Setting up redirects
This example sets up a redirect from `es2015` to `es6`:
```yml
# /es2015.md
---
title: ES2015
category: Hidden
redirect_to: /es6
---
Update the critical path with Parcel too
2020-06-14 13:09:47 +00:00
Add CONTRIBUTING.md
2017-09-04 01:44:14 +00:00
```
## Localizations
See `_data/content.yml` for chrome strings.
Add info on forking
2017-09-04 02:01:24 +00:00
## Forking
So you want to fork this repo? Sure, here's what you need to know to whitelabel this:
- It's all GitHub pages, so the branch has to be `gh-pages`.
- All other GitHub pages gotchas apply (CNAME, etc).
- Edit everything in `_data/` - this holds all 'config' for the site: ad IDs, strings, etc.
- Edit `_config.yml` as well, lots of things may not apply to you.
Add CloudFlare purging helper
2017-10-12 19:58:52 +00:00
## CloudFlare purging
The site devhints.io is backed by CloudFlare. Updates will take 2 days to propagate to the website by default. To make sure recent changes will propagate, use this helper script. It will give instructions on how manual selective cache purging can be done.
```bash
./_support/cf-purge.sh
```
Implement keywords-based descriptions
2017-10-15 18:02:23 +00:00
## SEO description
There are multiple ways to set meta description.
Formatting: capitalized first letter on some headings (#1044) Capitalized first letter on "Keywords," "Description," and "Intro" to be more consistent with document's current style.
2020-07-05 10:56:59 +00:00
### Keywords (and intro)
Implement keywords-based descriptions
2017-10-15 18:02:23 +00:00
Set `keywords` (and optionally `intro`). This is the easiest and the preferred
way for now.
```
React cheatsheet - devhints.io
------------------------------
https://devhints.io/react ▼
React.Component · render() · componentDidMount() · props/state · React is a
JavaScript library for building web...
```
Formatting: capitalized first letter on some headings (#1044) Capitalized first letter on "Keywords," "Description," and "Intro" to be more consistent with document's current style.
2020-07-05 10:56:59 +00:00
### Description (and intro)
Implement keywords-based descriptions
2017-10-15 18:02:23 +00:00
Set `description` (and optionally `intro`)
```
React cheatsheet - devhints.io
------------------------------
https://devhints.io/react ▼
One-page reference to React and its API. React is a JavaScript library for
building web user interfaces...
```
Formatting: capitalized first letter on some headings (#1044) Capitalized first letter on "Keywords," "Description," and "Intro" to be more consistent with document's current style.
2020-07-05 10:56:59 +00:00
### Intro only
Implement keywords-based descriptions
2017-10-15 18:02:23 +00:00
If you left out `description` or `keywords`, a default description will be added.