From 0f56d9fbf0aac8f8f11acf81e5dc3a91f93e9d0a Mon Sep 17 00:00:00 2001 From: Kevin Van Der Werff Date: Wed, 2 Oct 2019 13:35:27 +0200 Subject: [PATCH 1/5] :pencil: update README.md & webgems.code-snippets --- .vscode/webgems.code-snippets | 3 ++- README.md | 15 ++++++++++++--- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.vscode/webgems.code-snippets b/.vscode/webgems.code-snippets index f5e905c..6949e64 100644 --- a/.vscode/webgems.code-snippets +++ b/.vscode/webgems.code-snippets @@ -21,7 +21,8 @@ "{", " \"title\": \"${1:title}\",", " \"desc\": \"${2:desc}\",", - " \"url\": \"${3:url}\"", + " \"url\": \"${3:url}\",", + " \"tags\": \"[${4:tags}]\"", "}," ], "description": "Add a webgem" diff --git a/README.md b/README.md index 6a09626..f7faf3c 100644 --- a/README.md +++ b/README.md @@ -45,21 +45,30 @@ For any other editor, please use the following schema: { "title": "Awesome resource", "desc": "This awesome resource will make your life much easier.", // 1 - 2 sentences long. - "url": "https://url.com" + "url": "https://url.com", + "tags": ["UI", "workflow", "API"] // Please add at least 3 tags } ] } ] ``` -If you just want to add a resource to an already existing category, extend the `resources` array with your resources. Please include all the keys enlisted (`title`, `desc`, `url`). +In our [resources](resources/) we have an `.json` file for each category, you can add your suggested resource by adding it to the `resources` array in the JSON file using the schema as described above. Please include all the keys enlisted (`title`, `desc`, `url`, `tags` with at least 3 tags). For URLs, please consider the following: - Do not link to language specific pages (e.g. don't link to `.org/en-US/docs`, instead, link to `/docs` if possible). - Do not use `'&'` as it will break the URL referencing. - We won't allow referral links. -To add a completely new resource, include a new object at the root of the array, the pages are dynamically rendered so you don't have to worry about anything else. Again, include all the enlisted keys, reference to the schema above. +To add a completely new resource, add a `.json file to [resources](resources/). Make sure it follows the sceme like any other category resource: +```js +{ + "title": String, + "slug": String, // use lowecase letters, eg: "/ruby" + "resources": [Rescource] // Reference to above for schema of Resource +} +``` +Add it to [resources](resources/index.js) list of imports and export it aswell, that way Nuxt can take care of rendering the page. ## Built With From 9ecd2fbff35d2b17a00db283f5c551c7579374ff Mon Sep 17 00:00:00 2001 From: Kevin van der Werff Date: Wed, 2 Oct 2019 13:37:58 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7faf3c..d4e3207 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ For URLs, please consider the following: - Do not use `'&'` as it will break the URL referencing. - We won't allow referral links. -To add a completely new resource, add a `.json file to [resources](resources/). Make sure it follows the sceme like any other category resource: +To add a completely new resource, add a `.json` file to [resources](resources/). Make sure it follows the sceme like any other category resource: ```js { "title": String, @@ -68,7 +68,7 @@ To add a completely new resource, add a `.json file to [resources](res "resources": [Rescource] // Reference to above for schema of Resource } ``` -Add it to [resources](resources/index.js) list of imports and export it aswell, that way Nuxt can take care of rendering the page. +Add it to [resources.index.js](resources/index.js) list of imports and export it aswell, that way Nuxt can take care of rendering the page. ## Built With From b8e91c11ffd5c88fec1dee01a937f6eededb50ae Mon Sep 17 00:00:00 2001 From: Kevin van der Werff Date: Wed, 2 Oct 2019 13:41:57 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d4e3207..bcd2860 100644 --- a/README.md +++ b/README.md @@ -39,14 +39,14 @@ For any other editor, please use the following schema: ```js [ { - "title": "Category", - "slug": "/category", + "title": String, // Start with uppercase + "slug": String, // All lowercase, eg: "/category" "resources": [ { - "title": "Awesome resource", - "desc": "This awesome resource will make your life much easier.", // 1 - 2 sentences long. - "url": "https://url.com", - "tags": ["UI", "workflow", "API"] // Please add at least 3 tags + "title": String, + "desc": String, // 1 - 2 sentences long + "url": String, // See below for notes about correct format of URLs + "tags": [String] // Please add at least 3 tags } ] } @@ -60,14 +60,7 @@ For URLs, please consider the following: - Do not use `'&'` as it will break the URL referencing. - We won't allow referral links. -To add a completely new resource, add a `.json` file to [resources](resources/). Make sure it follows the sceme like any other category resource: -```js -{ - "title": String, - "slug": String, // use lowecase letters, eg: "/ruby" - "resources": [Rescource] // Reference to above for schema of Resource -} -``` +To add a completely new resource, add a `.json` file to [resources](resources/). Make sure it follows the sceme as described above. Add it to [resources.index.js](resources/index.js) list of imports and export it aswell, that way Nuxt can take care of rendering the page. ## Built With From 663c6f54775aeaad86b6aeef273018540434d0d0 Mon Sep 17 00:00:00 2001 From: Unknown Date: Wed, 2 Oct 2019 13:55:41 +0200 Subject: [PATCH 4/5] :pencil: adjust shortcut template --- .vscode/webgems.code-snippets | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/webgems.code-snippets b/.vscode/webgems.code-snippets index 6949e64..254eb2c 100644 --- a/.vscode/webgems.code-snippets +++ b/.vscode/webgems.code-snippets @@ -22,7 +22,7 @@ " \"title\": \"${1:title}\",", " \"desc\": \"${2:desc}\",", " \"url\": \"${3:url}\",", - " \"tags\": \"[${4:tags}]\"", + " \"tags\": [\"${4:tag}\"]", "}," ], "description": "Add a webgem" From 4fb23d4414855a9a8d8a7d96be37787ac2fa0bbf Mon Sep 17 00:00:00 2001 From: Kevin van der Werff Date: Wed, 2 Oct 2019 14:32:15 +0200 Subject: [PATCH 5/5] :pencil: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bcd2860..8b9e1a0 100644 --- a/README.md +++ b/README.md @@ -46,14 +46,14 @@ For any other editor, please use the following schema: "title": String, "desc": String, // 1 - 2 sentences long "url": String, // See below for notes about correct format of URLs - "tags": [String] // Please add at least 3 tags + "tags": [String] // Please try to add at least 3 tags } ] } ] ``` -In our [resources](resources/) we have an `.json` file for each category, you can add your suggested resource by adding it to the `resources` array in the JSON file using the schema as described above. Please include all the keys enlisted (`title`, `desc`, `url`, `tags` with at least 3 tags). +In our [resources](resources/) we have an `.json` file for each category, you can add your suggested resource by adding it to the `resources` array in the JSON file using the schema as described above. Please include all the keys enlisted (`title`, `desc`, `url`, `tags`). For URLs, please consider the following: - Do not link to language specific pages (e.g. don't link to `.org/en-US/docs`, instead, link to `/docs` if possible).