From d57d5d908ad80a47b8ce7c2df1bf288385bedbe6 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Fri, 29 Sep 2023 19:17:25 -0400 Subject: [PATCH 1/4] fix: change name of file --- database/technical-writing/tools.json | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 database/technical-writing/tools.json diff --git a/database/technical-writing/tools.json b/database/technical-writing/tools.json new file mode 100644 index 000000000..8892c8b6b --- /dev/null +++ b/database/technical-writing/tools.json @@ -0,0 +1,9 @@ +[ + { + "name": "Docsify", + "description": "If you're looking for a static generator that makes it easier for you to create docs, you'll love Docsify. Unlike GitBook, it does not generate static HTML files. Instead, it loads and parses your Markdown files and displays them as a website.", + "url": "https://docsify.js.org/#/", + "category": "technical writing", + "subcategory": "tools" + } +] From c0d715cd766370c98033db7d06d8363b892b3ec9 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Fri, 29 Sep 2023 19:34:49 -0400 Subject: [PATCH 2/4] feat: adding Docsify and technical writing --- database/data.ts | 23 +++++++++++++++++++---- database/index.ts | 2 ++ types/index.ts | 2 ++ 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/database/data.ts b/database/data.ts index a4201938a..f2abc2c6e 100644 --- a/database/data.ts +++ b/database/data.ts @@ -129,8 +129,16 @@ export const sidebarData: ISidebar[] = [ category: 'devops', subcategory: [ { name: 'CI/CD', url: '/cicd', resources: DB.cicd }, - { name: 'DevOps Life Cycle', url: '/devops-life-cycle', resources: DB.devopsLifecycle }, - { name: 'DevOps Methodologies', url: '/devops-methodologies', resources: DB.devopsMethodologies }, + { + name: 'DevOps Life Cycle', + url: '/devops-life-cycle', + resources: DB.devopsLifecycle, + }, + { + name: 'DevOps Methodologies', + url: '/devops-methodologies', + resources: DB.devopsMethodologies, + }, { name: 'docker', url: '/docker', resources: DB.docker }, { name: 'kubernetes', @@ -267,8 +275,15 @@ export const sidebarData: ISidebar[] = [ { name: 'Roadmaps', url: '/roadmaps', resources: DB.roadmaps }, ], }, + { + category: 'technical-writing', + subcategory: [{ name: 'Tools', url: '/tools', resources: DB.tools }], + }, ] export const subCategories = sidebarData.flatMap(({ category, subcategory }) => - subcategory.map(({ url }) => ({ category, subcategory: url.replace('/', '') })) -); + subcategory.map(({ url }) => ({ + category, + subcategory: url.replace('/', ''), + })) +) diff --git a/database/index.ts b/database/index.ts index 69a98197b..e3ed5d128 100644 --- a/database/index.ts +++ b/database/index.ts @@ -93,3 +93,5 @@ export { default as roadmaps } from './other/roadmaps.json' // competitive programming export { default as cpPlatforms } from './competitive_programming/cp-platforms.json' export { default as cpTutorials } from './competitive_programming/cp-tutorials.json' +// technical-writing +export { default as technicalwritingtools } from './technical-writing/tools.json' diff --git a/types/index.ts b/types/index.ts index cff48462f..4ee131d7b 100644 --- a/types/index.ts +++ b/types/index.ts @@ -160,4 +160,6 @@ export const subcategoryArray = [ 'roadmaps', // competitive programming 'platforms', + // technical-writing + 'tools', ] From e7388c471a818a8d65abfdf7da266e45e881a643 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Fri, 29 Sep 2023 20:01:34 -0400 Subject: [PATCH 3/4] feat: made some additions --- components/TopBar/CategoryDescriptions.ts | 2 ++ database/data.ts | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/components/TopBar/CategoryDescriptions.ts b/components/TopBar/CategoryDescriptions.ts index f2ebbbf3d..7224867d8 100644 --- a/components/TopBar/CategoryDescriptions.ts +++ b/components/TopBar/CategoryDescriptions.ts @@ -80,6 +80,8 @@ const categoryDescriptions: CategoryDescriptions = { 'other resources': 'Some extra resources to help you in your coding projects.', podcasts: 'Coding podcasts to listen to when you feel demotivated.', contributors: 'These are the people that have helped LinksHub come to life! Thank you for your support! Note: M = Maintainer and C = Contributors' + //technical-writing + 'technical-writingTools': 'This list provides the tools to suit your tech writing needs.', } export default categoryDescriptions diff --git a/database/data.ts b/database/data.ts index f2abc2c6e..9a33f5f66 100644 --- a/database/data.ts +++ b/database/data.ts @@ -277,7 +277,9 @@ export const sidebarData: ISidebar[] = [ }, { category: 'technical-writing', - subcategory: [{ name: 'Tools', url: '/tools', resources: DB.tools }], + subcategory: [ + { name: 'Tools', url: '/tools', resources: DB.technicalwritingTools }, + ], }, ] From d6843088657c39e347ef0c646db821a9bc3fff5a Mon Sep 17 00:00:00 2001 From: Rupali Haldiya Date: Sat, 30 Sep 2023 19:55:03 +0530 Subject: [PATCH 4/4] chore: fix category isssue --- components/TopBar/CategoryDescriptions.ts | 4 ++-- database/data.ts | 12 ++++++------ database/index.ts | 2 +- database/technical-writing/tools.json | 4 ++-- types/index.ts | 3 ++- 5 files changed, 13 insertions(+), 12 deletions(-) diff --git a/components/TopBar/CategoryDescriptions.ts b/components/TopBar/CategoryDescriptions.ts index 7224867d8..d85ab8966 100644 --- a/components/TopBar/CategoryDescriptions.ts +++ b/components/TopBar/CategoryDescriptions.ts @@ -79,9 +79,9 @@ const categoryDescriptions: CategoryDescriptions = { github: 'Well, Github does not need description, devs know well!', 'other resources': 'Some extra resources to help you in your coding projects.', podcasts: 'Coding podcasts to listen to when you feel demotivated.', - contributors: 'These are the people that have helped LinksHub come to life! Thank you for your support! Note: M = Maintainer and C = Contributors' + contributors: 'These are the people that have helped LinksHub come to life! Thank you for your support! Note: M = Maintainer and C = Contributors', //technical-writing - 'technical-writingTools': 'This list provides the tools to suit your tech writing needs.', + technicalWritingTools: 'This list provides the tools to suit your tech writing needs.', } export default categoryDescriptions diff --git a/database/data.ts b/database/data.ts index 9a33f5f66..fbf79dd29 100644 --- a/database/data.ts +++ b/database/data.ts @@ -259,6 +259,12 @@ export const sidebarData: ISidebar[] = [ { name: 'Tutorials', url: '/cp-tutorials', resources: DB.cpTutorials }, ], }, + { + category: 'technical-writing', + subcategory: [ + { name: 'Technical Writing Tools', url: '/technical-writing-tools', resources: DB.technicalWritingTools }, + ], + }, { category: 'other', subcategory: [ @@ -275,12 +281,6 @@ export const sidebarData: ISidebar[] = [ { name: 'Roadmaps', url: '/roadmaps', resources: DB.roadmaps }, ], }, - { - category: 'technical-writing', - subcategory: [ - { name: 'Tools', url: '/tools', resources: DB.technicalwritingTools }, - ], - }, ] export const subCategories = sidebarData.flatMap(({ category, subcategory }) => diff --git a/database/index.ts b/database/index.ts index e3ed5d128..2cf8833ce 100644 --- a/database/index.ts +++ b/database/index.ts @@ -94,4 +94,4 @@ export { default as roadmaps } from './other/roadmaps.json' export { default as cpPlatforms } from './competitive_programming/cp-platforms.json' export { default as cpTutorials } from './competitive_programming/cp-tutorials.json' // technical-writing -export { default as technicalwritingtools } from './technical-writing/tools.json' +export { default as technicalWritingTools } from './technical-writing/tools.json' diff --git a/database/technical-writing/tools.json b/database/technical-writing/tools.json index 8892c8b6b..66f8b8e2b 100644 --- a/database/technical-writing/tools.json +++ b/database/technical-writing/tools.json @@ -3,7 +3,7 @@ "name": "Docsify", "description": "If you're looking for a static generator that makes it easier for you to create docs, you'll love Docsify. Unlike GitBook, it does not generate static HTML files. Instead, it loads and parses your Markdown files and displays them as a website.", "url": "https://docsify.js.org/#/", - "category": "technical writing", - "subcategory": "tools" + "category": "technical-writing", + "subcategory": "technical-writing-tools" } ] diff --git a/types/index.ts b/types/index.ts index 4ee131d7b..2aeb2944a 100644 --- a/types/index.ts +++ b/types/index.ts @@ -45,6 +45,7 @@ export type Category = | 'other' | 'devops' | 'competitive-programming' + | 'technical-writing' export type SubCategories = { name: string @@ -161,5 +162,5 @@ export const subcategoryArray = [ // competitive programming 'platforms', // technical-writing - 'tools', + 'technical-writing-tools', ]