gsasansol / GirlScript-Asansol

Github repository for the official website of GirlScript Foundation's Asansol Chapter using Vanilla JS
https://girlscript-asansol.netlify.app
MIT License
53 stars 73 forks source link

Compose an original writeup Document/Roadmap on DBMS (brief introduction to SQL/NoSQL) #21

Closed regdocs closed 1 year ago

regdocs commented 1 year ago
utkarsh006 commented 1 year ago

@jay-io Kindly assign me this issue.

regdocs commented 1 year ago

@utkarsh006 sure, go ahead!

utkarsh006 commented 1 year ago

@jay-io What files I would be adding to Github? Should I write the article as markdown file?

regdocs commented 1 year ago

@utkarsh006 You need to save the article as a JSON in this format and place it in the path components/articles.

{
  "title": "TITLE GOES HERE",
  "body": "MARKDOWN ARTICLE FORMATTED AS UTF-8 STRING",
  "author": "FIRSTNAME LASTNAME",
  "email": "AUTHOR EMAIL",
  "date": "DATE OF PULL REQUEST & FORMAT AS <DD/MM/YYYY>",
  "references": [
    "LIST",
    "OF",
    "REFERENCES"
  ]
}

Use Node's fs module to generate your UTF8 string from the Markdown article:

const fs = require('fs');

fs.writeFileSync(
  'D:\path\to\output.txt', 
  JSON.stringify(
    fs.readFileSync('C:\path\to\markdown\article.md')
      .toString('utf8')
  )
);

Markdown guide: https://www.markdownguide.org/basic-syntax/ For queries, visit our Discord.

regdocs commented 1 year ago

@utkarsh006 Can you adopt a more paragraph-based writing style? Perhaps, discuss what each header means. Also, include a few other standard database systems in use these days (along with their use cases) and cut down a little on the difficult terminologies. If I'd be honest, it currently resembles the index of an advanced book on DBMS. For suggestions, see how this article is structured.

Also, the articles should not be job interview centric. It should be something beginners can understand and relate to (and even possibly feel motivated enough to get started implementing them after reading your composition). In terms of roadmap, discuss what the most basic database is for the beginners (Mongo Atlas?), its philosophies and how they can quickly get started. What's the next database they could learn to ease the learning curve? Why learn databases anyway?

The main idea here is to learn while teaching others. I hope you understand what we're getting at. Feel free to ask queries if you still have any.

debjitpurohit commented 1 year ago

I am a hacktoberfest 2022 participant. Please assing this issue to me.

regdocs commented 1 year ago

@debjitpurohit Go ahead.