From 990f51293b1e85bc1146b291784474c82fabba37 Mon Sep 17 00:00:00 2001 From: Adam Bard Date: Mon, 13 Nov 2017 13:45:40 -0800 Subject: Update CONTRIBUTING.markdown --- CONTRIBUTING.markdown | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 5fa1d03d..455c3256 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -71,3 +71,10 @@ contributors: lang: ep-ep --- ``` + +### Should I add myself as a Contributor? + +If you want to add yourself to contributors, keep in mind that contributors get +equal billing, and the first contributor usually wrote the whole article. Please +use your judgement when deciding if your contribution constitutes a substantial +addition or not. -- cgit v1.2.3 From bcd10cdd362a3996af82998f1073c44645dc4d2d Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sat, 17 Nov 2018 19:04:43 +0530 Subject: Add local build instructions, closes #3396 --- CONTRIBUTING.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 455c3256..0c35c3f2 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -78,3 +78,21 @@ If you want to add yourself to contributors, keep in mind that contributors get equal billing, and the first contributor usually wrote the whole article. Please use your judgement when deciding if your contribution constitutes a substantial addition or not. + +## Building the site locally + +You can buid the site locally to test your changes. Follow the steps below. + +* Install Ruby language runtime and RubyGems. See [here](https://middlemanapp.com/basics/install/) for more details. +* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. + * `git clone https://github.com/adambard/learnxinyminutes-site` +* Install Middleman and other required dependencies using Bundler. + * `cd learnxinyminutes-site/` + * `bundle install` +* Checkout the [learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs) repo as `source/docs`. + * `cd source/docs/` + * `git clone https://github.com/adambard/learnxinyminutes-docs ./source/docs/` +* Build the site or run a development server to test your changes (NOTE: run +these commands at `learnxinyminutes-site/`). + * Build - `bundle exec middleman build` + * Dev server - `bundle exec middleman --force-polling --verbose` -- cgit v1.2.3 From 195e46d15f9e91cc8f7e8b8ad457ac02c86c6b98 Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sun, 18 Nov 2018 00:32:47 +0530 Subject: Update local site building instructions --- CONTRIBUTING.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 0c35c3f2..e2b849bd 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -89,9 +89,14 @@ You can buid the site locally to test your changes. Follow the steps below. * Install Middleman and other required dependencies using Bundler. * `cd learnxinyminutes-site/` * `bundle install` -* Checkout the [learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs) repo as `source/docs`. - * `cd source/docs/` - * `git clone https://github.com/adambard/learnxinyminutes-docs ./source/docs/` +* Get the source in place + * Copy the contents of your clone of the fork of learnxinyminutes-docs repo + into the `source/docs` folder. There shouldn't be a learnxinyminutes-docs + folder inside the `docs` folder, it should just contain all the repo + contents. + * Checkout your fork of the learnxinyminutes-docs repo as `source/docs`. + * `cd source/docs/` + * `git clone https://github.com/YOUR-USERNAME/learnxinyminutes-docs ./source/docs/` * Build the site or run a development server to test your changes (NOTE: run these commands at `learnxinyminutes-site/`). * Build - `bundle exec middleman build` -- cgit v1.2.3 From 9a3c737c42d2ca861ccb7ae6159301bcf284ee32 Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sun, 18 Nov 2018 00:39:46 +0530 Subject: Highlighting fix --- CONTRIBUTING.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index e2b849bd..e2192d88 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -91,7 +91,7 @@ You can buid the site locally to test your changes. Follow the steps below. * `bundle install` * Get the source in place * Copy the contents of your clone of the fork of learnxinyminutes-docs repo - into the `source/docs` folder. There shouldn't be a learnxinyminutes-docs + into the `source/docs` folder. There shouldn't be a `learnxinyminutes-docs` folder inside the `docs` folder, it should just contain all the repo contents. * Checkout your fork of the learnxinyminutes-docs repo as `source/docs`. -- cgit v1.2.3 From 790c47319c589be457e4ee3a17d1983250492614 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pierre-Fran=C3=A7ois=20Clement?= Date: Fri, 8 Mar 2019 17:24:13 +0100 Subject: Add infos about the "category" header in CONTRIBUTING.md --- CONTRIBUTING.markdown | 2 ++ 1 file changed, 2 insertions(+) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index e2192d88..18a5a5d7 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -52,6 +52,8 @@ languages: Other fields: +- **category**: The category of the article. So far, can be one of *language*, + *tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted. - **filename**: The filename for this article's code. It will be fetched, mashed together, and made downloadable. + For non-English articles, *filename* should have a language-specific -- cgit v1.2.3 From 5e7c4f2f78247212d9bdfafa01b39a4dd8b7f4f6 Mon Sep 17 00:00:00 2001 From: Javier Candeira Date: Sat, 31 Aug 2019 23:59:33 +1000 Subject: Nixify so it can be easily developed on Nix --- CONTRIBUTING.markdown | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 18a5a5d7..79d6838a 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -103,3 +103,11 @@ You can buid the site locally to test your changes. Follow the steps below. these commands at `learnxinyminutes-site/`). * Build - `bundle exec middleman build` * Dev server - `bundle exec middleman --force-polling --verbose` + +## Building the site locally, for Nix users + +You can buid the site locally to test your changes too: + +* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. +* Get the source in place following the instructions above +* Install all site dependencies and start a dev server by running `nix-shell` at the `learnxinyminutes-site/` root directory. -- cgit v1.2.3 From a122e2852c63ccaff29ac16f1ef4d06fc1a94908 Mon Sep 17 00:00:00 2001 From: Adam Bard Date: Sat, 2 Nov 2019 12:19:30 -0700 Subject: Revert "Nixify so it can be easily developed on Nix" --- CONTRIBUTING.markdown | 8 -------- 1 file changed, 8 deletions(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 79d6838a..18a5a5d7 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -103,11 +103,3 @@ You can buid the site locally to test your changes. Follow the steps below. these commands at `learnxinyminutes-site/`). * Build - `bundle exec middleman build` * Dev server - `bundle exec middleman --force-polling --verbose` - -## Building the site locally, for Nix users - -You can buid the site locally to test your changes too: - -* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. -* Get the source in place following the instructions above -* Install all site dependencies and start a dev server by running `nix-shell` at the `learnxinyminutes-site/` root directory. -- cgit v1.2.3 From d5432679c75c57dd280af957df8063d10b30db99 Mon Sep 17 00:00:00 2001 From: Barton Stanley Date: Fri, 31 Jan 2020 14:20:14 -0600 Subject: [CONTRIBUTING.markdown] Change "buid" to "build" --- CONTRIBUTING.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 18a5a5d7..3dfd38ce 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -83,7 +83,7 @@ addition or not. ## Building the site locally -You can buid the site locally to test your changes. Follow the steps below. +You can build the site locally to test your changes. Follow the steps below. * Install Ruby language runtime and RubyGems. See [here](https://middlemanapp.com/basics/install/) for more details. * Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. -- cgit v1.2.3