Skip to content

Commit 4a05c6f

Browse files
added first docs
1 parent 0fe25bc commit 4a05c6f

File tree

5 files changed

+195
-56
lines changed

5 files changed

+195
-56
lines changed

.idea/data-science-interview-prep.iml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+33-32
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,49 @@
11
# data-science-interview-prep
2+
<p align="center">
23

3-
## Setup
4+
[![website](https://img.shields.io/badge/GO%20TO%20WEBSITE-Data%20Science%20Interview%20preparation-%3CCOLOR%3E.svg)](https://singhsidhukuldeep.github.io/data-science-interview-prep/)
45

5-
**Important:** *It is strongly adviced to use virtual environment and not change anything in `gh-pages`*
6+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/singhsidhukuldeep)
7+
[![Website shields.io](https://img.shields.io/website?url=https%3A%2F%2Fsinghsidhukuldeep.github.io%2Fdata-science-interview-prep%2F)](https://singhsidhukuldeep.github.io/data-science-interview-prep/)
8+
[![GitHub pages status](https://img.shields.io/github/deployments/singhsidhukuldeep/data-science-interview-prep/github-pages)](https://github.com/singhsidhukuldeep/data-science-interview-prep/deployments/activity_log?environment=github-pages)
9+
[![Issues](https://img.shields.io/github/issues/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues)
10+
[![Commits](https://img.shields.io/github/last-commit/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/commits/master)
11+
[![Contributors](https://img.shields.io/github/contributors/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/graphs/contributors)
612

7-
* **`Linux`** Systems:
13+
[![](https://img.shields.io/github/forks/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/network/members)
14+
[![](https://img.shields.io/github/stars/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/stargazers)
15+
[![](https://img.shields.io/github/watchers/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/watchers)
16+
[![](https://img.shields.io/github/followers/singhsidhukuldeep?style=social)](https://github.com/singhsidhukuldeep?tab=followers)
817

9-
```shell
10-
python3 -m venv ./venv
18+
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
19+
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
20+
[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)
1121

12-
source venv/bin/activate
22+
</p>
1323

14-
pip3 install -r requirements.txt
15-
```
24+
This is a completely open-source project for maintaining curated list of interview questions and answers for people preparing for such interviews.
1625

17-
```shell
18-
deactivate
19-
```
26+
You can also find other materials like tutorials, online materials, etc on the platform.
2027

21-
* **`Windows`** Systems:
28+
**This is maintained by you!** You can answer/ improve existing questions or you can send new questions that you faced during interviews.
2229

23-
```shell
24-
python3 -m venv ./venv
30+
## Credits
2531

26-
venv\Scripts\activate
32+
### Maintained by
2733

28-
pip3 install -r requirements.txt
29-
```
34+
***Kuldeep Singh Sidhu***
3035

31-
```shell
32-
venv\Scripts\deactivate
33-
```
34-
35-
## Useful Commands
36+
Github: [github/singhsidhukuldeep](https://github.com/singhsidhukuldeep)
37+
`https://github.com/singhsidhukuldeep`
3638

37-
* `mkdocs new [dir-name]` - Create a new project.
38-
* `mkdocs serve` - Start the live-reloading docs server.
39-
* `mkdocs build` - Build the documentation site.
40-
* `mkdocs -h` - Print help message and exit.
41-
* `mkdocs gh-deploy` - Use `mkdocs gh-deploy --help` to get a full list of options available for the `gh-deploy` command.
42-
Be aware that you will not be able to review the built site before it is pushed to GitHub. Therefore, you may want to verify any changes you make to the docs beforehand by using the `build` or `serve` commands and reviewing the built files locally.
43-
44-
## Useful Documents
39+
Website: [Kuldeep Singh Sidhu (Website)](http://kuldeepsinghsidhu.com)
40+
`http://kuldeepsinghsidhu.com`
4541

46-
* MkDocs: [https://github.com/mkdocs/mkdocs](https://github.com/mkdocs/mkdocs)
42+
LinkedIn: [Kuldeep Singh Sidhu (LinkedIn)](https://www.linkedin.com/in/singhsidhukuldeep/)
43+
`https://www.linkedin.com/in/singhsidhukuldeep/`
4744

48-
* Theme: [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)
45+
### Contributors
46+
47+
The full list of all the contributors is available [here](https://github.com/singhsidhukuldeep/data-science-interview-prep/graphs/contributors)
48+
49+
[![website](https://forthebadge.com/images/badges/built-with-love.svg)](https://singhsidhukuldeep.github.io/data-science-interview-prep/)

docs/index.md

+136-19
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,150 @@
11
# Home
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
3+
## Introduction
44

5-
## Commands
5+
This is a completely open-source project for maintaining curated list of interview questions and answers for people preparing for such interviews.
66

7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
7+
You can also find other materials like tutorials, online materials, etc on the platform.
118

12-
## Project layout
9+
**This is maintained by you!** You can answer/ improve existing questions or you can send new questions that you faced during interviews.
1310

14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.
11+
## Contribute to the project
1812

19-
## Installation
13+
Any contribution is deeply appreciated. 🙏
2014

21-
* MkDocs: [https://github.com/mkdocs/mkdocs](https://github.com/mkdocs/mkdocs)
15+
### Add a question
2216

23-
* Theme: [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)
17+
❓ Add your question [here](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues). Add a detailed description of your question so that any person with enough subject knowledge is able to understand your question and frame the answer.
18+
19+
As of now, you cannot directly add a question via a pull request. This is to maintain the quality of the content.
20+
21+
### Add answers/topics
22+
23+
📝 These are the answers/topics that need your help at the moment
24+
25+
* [x] Add documentation for the project
26+
* [ ] Python common DSA question
27+
* [ ] Add Major ML topics
28+
* [ ] Add Pandas questions
29+
* [ ] Add NumPy questions
30+
* [ ] Add TensorFlow questions
31+
* [ ] Add PyTorch questions
32+
* [ ] Add list of learning resources
33+
34+
### Issues
35+
36+
🔧 *You can report any issues* 🧐 *that you find to me on [LinkedIn](#maintained-by) or [raise an issue](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues) in GitHub*
37+
38+
🛠 You can also solve existing [issues on GitHub](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues) and create a pull request.
39+
40+
## Setup
41+
42+
> No setup is required for usage of the platform
43+
44+
**Important:** *It is strongly advised to use virtual environment and not change anything in `gh-pages`*
2445

46+
### `Linux` Systems
47+
48+
```shell
49+
python3 -m venv ./venv
50+
51+
source venv/bin/activate
52+
53+
pip3 install -r requirements.txt
54+
```
55+
56+
```shell
57+
deactivate
58+
```
59+
60+
### `Windows` Systems
61+
62+
```shell
63+
python3 -m venv ./venv
64+
65+
venv\Scripts\activate
66+
67+
pip3 install -r requirements.txt
2568
```
69+
70+
```shell
71+
venv\Scripts\deactivate
72+
```
73+
74+
### To install the latest
75+
76+
```shell
2677
pip3 install mkdocs
2778
pip3 install mkdocs-material
28-
```
79+
```
80+
81+
## Useful Commands
82+
83+
* `mkdocs serve` - Start the live-reloading docs server.
84+
* `mkdocs build` - Build the documentation site.
85+
* `mkdocs -h` - Print help message and exit.
86+
* `mkdocs gh-deploy` - Use `mkdocs gh-deploy --help` to get a full list of options available for the `gh-deploy` command.
87+
Be aware that you will not be able to review the built site before it is pushed to GitHub. Therefore, you may want to verify any changes you make to the docs beforehand by using the `build` or `serve` commands and reviewing the built files locally.
88+
* ~~`mkdocs new [dir-name]` - Create a new project.~~ No need to create a new project
89+
90+
## Useful Documents
91+
92+
* MkDocs: [https://github.com/mkdocs/mkdocs](https://github.com/mkdocs/mkdocs)
93+
94+
* Theme: [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)
95+
96+
## FAQ
97+
98+
* Can I filter questions based on companies? 🤪
99+
100+
As much as this platform is meant to help with your interview preparation. It is not a sure shot short-cut to cracking an interview.
101+
Think of this platform where you practice the skills that you have from a interview perspective,
102+
keeping that in mind the questions are sorted by topics but not by companies. 🤓
103+
104+
This doesn't mean that such feature won't be added in the future. "*Never say Never*" But as of now neither there is a plan nor data to do so. 😢
105+
106+
* Why is this platform free? 🤗
107+
108+
Currently there is no major cost involved in maintaining this project other than time and effort that is put in by every [contributor](https://github.com/singhsidhukuldeep/data-science-interview-prep/graphs/contributors).
109+
If you want to help you can [contribute here](#contribute-to-the-project).
110+
111+
If you still want to pay for something that is free, we would request you to donate it to a charity 😇 of your choice instead.
112+
113+
## Credits
114+
115+
### Maintained by
116+
117+
👨‍🎓 ***Kuldeep Singh Sidhu***
118+
119+
🔧 *You can report any issues* 🧐 *that you find to me on LinkedIn or [raise an issue](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues) in GitHub*
120+
121+
Github: [github/singhsidhukuldeep](https://github.com/singhsidhukuldeep)
122+
`https://github.com/singhsidhukuldeep`
123+
124+
Website: [Kuldeep Singh Sidhu (Website)](http://kuldeepsinghsidhu.com)
125+
`http://kuldeepsinghsidhu.com`
126+
127+
LinkedIn: [Kuldeep Singh Sidhu (LinkedIn)](https://www.linkedin.com/in/singhsidhukuldeep/)
128+
`https://www.linkedin.com/in/singhsidhukuldeep/`
129+
130+
### Contributors
131+
132+
😎 The full list of all the contributors is available [here](https://github.com/singhsidhukuldeep/data-science-interview-prep/graphs/contributors)
133+
134+
## Current Status
135+
136+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/singhsidhukuldeep)
137+
[![Website shields.io](https://img.shields.io/website?url=https%3A%2F%2Fsinghsidhukuldeep.github.io%2Fdata-science-interview-prep%2F)](https://singhsidhukuldeep.github.io/data-science-interview-prep/)
138+
[![GitHub pages status](https://img.shields.io/github/deployments/singhsidhukuldeep/data-science-interview-prep/github-pages)](https://github.com/singhsidhukuldeep/data-science-interview-prep/deployments/activity_log?environment=github-pages)
139+
[![Issues](https://img.shields.io/github/issues/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/issues)
140+
[![Commits](https://img.shields.io/github/last-commit/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/commits/master)
141+
[![Contributors](https://img.shields.io/github/contributors/singhsidhukuldeep/data-science-interview-prep)](https://github.com/singhsidhukuldeep/data-science-interview-prep/graphs/contributors)
142+
143+
[![](https://img.shields.io/github/forks/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/network/members)
144+
[![](https://img.shields.io/github/stars/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/stargazers)
145+
[![](https://img.shields.io/github/watchers/singhsidhukuldeep/data-science-interview-prep?style=social)](https://github.com/singhsidhukuldeep/data-science-interview-prep/watchers)
146+
[![](https://img.shields.io/github/followers/singhsidhukuldeep?style=social)](https://github.com/singhsidhukuldeep?tab=followers)
29147

30-
??? note "Phasellus posuere in sem ut cursus"
31-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
32-
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
33-
massa, nec semper lorem quam in massa.
148+
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
149+
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
150+
[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)

mkdocs.yml

+24-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
site_name: Data Science Interview prep
1+
site_name: Data Science Interview preparation
22
repo_name: singhsidhukuldeep/data-science-interview-prep
33
repo_url: https://github.com/singhsidhukuldeep/data-science-interview-prep
44
extra:
55
social:
6-
- icon: fontawesome/brands/github-alt
6+
- icon: octicons/mark-github-16
77
link: https://github.com/singhsidhukuldeep/
88
- icon: fontawesome/brands/linkedin
99
link: https://linkedin.com/in/singhsidhukuldeep
1010
- icon: fontawesome/brands/stack-overflow
1111
link: https://stackoverflow.com/u/7182350/
12+
- icon: octicons/globe-16
13+
link: http://kuldeepsinghsidhu.com
1214
- icon: fontawesome/brands/git-alt
1315
link: https://github.com/singhsidhukuldeep/data-science-interview-prep
1416
theme:
@@ -27,4 +29,23 @@ theme:
2729
plugins:
2830
- search:
2931
lang:
30-
- en
32+
- en
33+
markdown_extensions:
34+
- pymdownx.arithmatex
35+
- pymdownx.betterem:
36+
smart_enable: all
37+
- pymdownx.caret
38+
- pymdownx.critic
39+
- pymdownx.details
40+
- pymdownx.emoji:
41+
emoji_index: !!python/name:materialx.emoji.twemoji
42+
emoji_generator: !!python/name:materialx.emoji.to_svg
43+
- pymdownx.inlinehilite
44+
- pymdownx.magiclink
45+
- pymdownx.mark
46+
- pymdownx.smartsymbols
47+
- pymdownx.superfences
48+
- pymdownx.tasklist:
49+
custom_checkbox: true
50+
- pymdownx.tabbed
51+
- pymdownx.tilde

0 commit comments

Comments
 (0)