datamuni

Visit us at: DataMuni.com

Writing an article on DataMuni

....is pretty easy!

Step 0: Fork this repository!

First time user

First time users need to create a profile and write article in the same Pull Request (PR). To create your own user, follow these steps:

  • Create a folder by the same name as your github account name inside users/. Let's call it username. Note: this must be same as your github username!
  • Create your own PROFILE.md inside username. You can add all kinds of information about yourself here and update it anytime you want.

Now you can write articles. Please note that it is not allowed to just create the user and not write any articles. :)

Write an article

  • Inside your username, create a folder that will be the URL title. e.g. supervised-vs-unsupervised-learning. Please note that this name can only contain hyphens and english alphabets.
  • Write your article in ARTICLE.md inside this folder.
  • Add assets, e.g. any images to assets inside this folder.
  • Create a file called title (without extensions) and add title of your article. It is the name that will be used everywhere in the website. Note that your ARTICLE.md must also have a title. :

Final structure should look like this:

datamuni
    |-- users
        |-- username
        |   |-- PROFILE.md
        |   |-- article-example-1
        |   |   |-- ARTICLE.md
        |   |   |-- title
        |   |   `-- assets
        |   |       |-- 1.png
        |   |       |-- 2.png
        |   |       `-- 3.png
        |	|-- article-example-2
        |	|   |-- ARTICLE.md

Please note: - In one PR, you can add yourself as a user and write one article - Users without articles will not be accepted - You can add only one article with one PR

As soon as you create your PR, it will be reviewed and you will be allowed to make changes to make it better. If everything is fine, your PR will be merged and will be visible on DataMuni.com :)

Have fun writing good-quality, no-nonsense articles and help the community!