Skip to content

Commit

Permalink
Add about page
Browse files Browse the repository at this point in the history
  • Loading branch information
@kamranahmedse
kamranahmedse committed Nov 21, 2022
1 parent 7a31d72 commit 1b089c5
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 59 deletions.
12 changes: 0 additions & 12 deletions bin/readme.md
View file

This file was deleted.

63 changes: 63 additions & 0 deletions contributing.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contribution

First of all thank you for considering to contribute. Please look at the details below:

* [New Roadmaps](#new-roadmaps)
* [Existing Roadmaps](#existing-roadmaps)
* [Adding Content](#adding-content)
* [Guidelines](#guidelines)

## New Roadmaps

For new roadmaps, submit a roadmap by providing [a textual roadmap similar to this roadmap](https://gist.github.com/kamranahmedse/98758d2c73799b3a6ce17385e4c548a5) in an issue.

## Existing Roadmaps

For the existing roadmaps, please follow the details listed for the nature of contribution:

* **Fixing Typos** — Make your changes in the [roadmap JSON file](https://github.com/kamranahmedse/developer-roadmap/tree/master/public/project)
* **Adding or Removing Nodes** — Please open an issue with your suggestion.

**Note:** Please note that our goal is not to have the biggest list of items. Our goal is to list items or skills most relevant today.

## Adding Content

Find [the content directory inside the relevant roadmap](https://github.com/kamranahmedse/developer-roadmap/tree/master/content/roadmaps).

Please note that the markdown has a specific format. Please follow the sample format for markdown as given here.

* Title of the file to represent the node item.
* Add a brief summary describing the roadmap node (preferably less than 200 characters)
* Use `ResourceGroupTitle` tag for the resources heading

```html
<ResourceGroupTitle>Free Content</ResourceGroupTitle>
```

* Use `BadgeLink` tag for the resource links with below guidelines

```html
<!-- blue color scheme for the official websites and documentation -->
<BadgeLink colorScheme='blue' badgeText='Official Website' href='https://reactjs.org/'>React Website</BadgeLink>

<!-- green color scheme for the courses -->
<BadgeLink badgeText='Course' colorScheme='green' href='https://example.com'>The Beginner's Guide to React</BadgeLink>

<!-- no color scheme for the video links -->
<BadgeLink badgeText='Watch' href='https://www.youtube.com/watch?v=i793Qm6kv3U'>Understanding React's UI Rendering Process</BadgeLink>

<!-- yellow color scheme for the blog posts and readable text -->
<BadgeLink colorScheme='yellow' badgeText='Read' href='https://www.cloudflare.com/en-gb/learning/dns/what-is-dns/'>What is DNS?</BadgeLink>

```

## Guidelines

- <p><strong>Adding everything available out there is not the goal!</strong><br />
The roadmaps represent the skillset most valuable today, i.e., if you were to enter any of the listed fields today, what would you learn?! There might be things that are of-course being used today but prioritize the things that are most in demand today, e.g., agreed that lots of people are using angular.js today but you wouldn't want to learn that instead of React, Angular, or Vue. Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included.</p>
- <p><strong>Do not add things you have not evaluated personally!</strong><br />
Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included. Have you read this book? Can you give a short article?</p>
- <p><strong>Create a Single PR for Content Additions</strong></p>
If you are planning to contribute by adding content to the roadmaps, I recommend you to clone the repository, add content to the [content directory of the roadmap](./content/roadmaps/) and create a single PR to make it easier for me to review and merge the PR.
- Write meaningful commit messages
- Look at the existing issues/pull requests before opening new ones
6 changes: 4 additions & 2 deletions src/_includes/components/footer.njk
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@
<p>
&copy; roadmap.sh
<span class='mx-1.5'>&middot;</span>
<a href='#' class='hover:text-white'>Terms</a>
<a href='/about' class='hover:text-white'>FAQs</a>
<span class='mx-1.5'>&middot;</span>
<a href='#' class='hover:text-white'>Privacy</a>
<a href='/terms' class='hover:text-white'>Terms</a>
<span class='mx-1.5'>&middot;</span>
<a href='/privacy' class='hover:text-white'>Privacy</a>
</p>
</div>
</div>
Expand Down
79 changes: 34 additions & 45 deletions src/about.njk
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,75 +43,64 @@ tags:
<div class='max-w-[800px] container'>
<main id='main-content'>
<div class='mb-5'>
<h2 class='text-3xl font-bold mb-2'>What is roadmap.sh?</h2>
<p class='mb-3'><span class="font-bold ">roadmap.sh</span> contains community-curated roadmaps, study plans, paths, and resources for developers. There are role-based roadmaps, listing skills you should for any given role, as well as skill-based roadmaps listing items to learn for any given skill.</p>
<p>It started as a set of <a href='https://github.com/kamranahmedse/developer-roadmap' class='font-bold underline' target='_blank'>visual charts on GitHub</a> to guide the developers who are confused about what they should learn next, but then expanded into interactive roadmaps where you can click and get resources to learn any given resource.</p>
<h2 class='text-2xl font-bold mb-2'>What is roadmap.sh?</h2>
<p class='mb-3'><span class="font-bold ">roadmap.sh</span> contains community-curated roadmaps, study plans,
paths, and resources for developers. There are role-based roadmaps, listing skills you should for any given
role, as well as skill-based roadmaps listing items to learn for any given skill.</p>
<p class='mb-3'>It started as a set of <a href='https://github.com/kamranahmedse/developer-roadmap'
class='font-bold underline' target='_blank'>visual charts on GitHub</a> to guide
the developers who are confused about what they should learn next, but then expanded into interactive roadmaps
where you can click and get resources to learn any given resource, contribute by adding new roadmaps, suggest changes to existing roadmaps, track your progress as you follow a roadmap and so on.</p>
</div>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-2'>Can I trust roadmap.sh?</h2>
<p class='mb-3'>It's <a href='https://github.com/search?o=desc&q=stars%3A%3E100000&s=stars&type=Repositories' target='_blank' class='font-bold underline'>6th most starred opensource project</a>, visited by hundreds of thousands of developers every month. All the roadmaps are created and reviewed by community and several subject matter experts.</p>
<h2 class='text-2xl font-bold mb-2'>How are roadmaps created?</h2>
<p class='mb-3'>
The project has a strong community that powers everything on the website. It is <a href='https://github.com/search?o=desc&q=stars%3A%3E100000&s=stars&type=Repositories'
target='_blank' class='font-bold underline'>the 6th most starred opensource project on GitHub</a> and gets visited by hundreds of thousands of developers every month.
We also have newsletter with 150,000+ developers. All the roadmaps are created and reviewed by community and several subject matter experts. Also, anyone can suggest changes to any roadmap and we have a process to review and approve them.
</p>
</div>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>What are the plans for roadmap.sh?</h2>
<p>The website started off as <a href='#'>simple repository containing a few charts</a> for developers and based on my personal opinions but it could have been much more than that so I decided to expand it to a website where people can contribute to study plans with their areas of expertise as well, add more roadmaps, write guides etc.</p>
<p>We haven't opened up the sign ups for now but we will be doing. My long term plans for this website are to
turn it into a goto place for the developers to seek guidance about their careers, help others, share their
journeys, incentivize the learnings, get feedbacks on their projects etc.</p>
<h2 class='text-2xl font-bold mb-2'>What are the plans for roadmap.sh?</h2>
<p class='mb-3'>Our long-term plan is to make roadmap.sh a go-to place for developers whenever they plan on learning something new. We started with roadmaps, guides, videos and other visual content but we plan on introducing best practices, checklists for certain tasks, quizzes to test your knowledge and prepare yourself for the interviews, project ideas to work on while following the roadmaps, public profiles to share your progress and interact with the other learners and so on.</p>
</div>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>How did you build roadmap.sh?</h2>
<p>The basic version of the website has been built with Next.js, is opensource and can be found on GitHub. It
was hastily done to get it out in front of the people and get people to start contributing, so it might be
rough on the edges, but that is where we need your help.</p>
<h2 class='text-2xl font-bold mb-2'>How is roadmap.sh built?</h2>
<p class='mb-3'>The website is built with <a href='https://www.11ty.dev/' class='font-bold underline' target='_blank' rel='nofollow'>Eleventy</a> and <a
href='https://tailwindcss.com/' class='font-bold underline' target='_blank' rel='nofollow'>Tailwind</a> and is deployed to <a
href='https://pages.github.com/' class='font-bold underline' target='_blank' rel='nofollow'>GitHub pages</a>. The project is fully open-source and the codebase
<a href='https://github.com/kamranahmedse/developer-roadmap' class='font-bold underline' target='_blank'>can be found on GitHub</a></p>
</div>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>How does it make money?</h2>
<p>It doesn't make any money. I have been using my personal time and budget to build it. I did not create this
website with any intentions of monetization but as a good will, to help the people get out of the frustration
that I was once in.</p>
<p>Having said that, I love teaching and my future plans are to be able to work full-time on roadmap.sh for
which it has to make enough money to pay for my rent, groceries, bills, travel expenses, etc but even if it
doesn't it's likely that I'll continue growing the site however I can. My focus at the moment is not making
money from it and just adding content that creates value for the people.</p>
<h2 class='text-2xl font-bold mb-2'>How can I add a new roadmap?</h2>
<p class='mb-3'>For new roadmaps, please open an issue with the textual description of the roadmap in the form of bulleted list. Here is an <a target='_blank' class='font-bold underline' href='https://github.com/kamranahmedse/developer-roadmap/issues/1387#issue-1329276631'>example contribution of a new roadmap</a>.</p>
<p class='mb-3'>Find more details in the <a href='https://github.com/kamranahmedse/developer-roadmap/blob/master/contributing.md' class='font-bold underline' target='_blank'>contribution docs</a>.</p>
</div>

<blockquote>Sponsor the efforts by paying as little as 5$ per month or with one time payment via paypal.
Alternatively, reach out to me at kamranahmed.se@gmail.com.
</blockquote>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>Can I contribute?</h2>
<p>You definitely can, infact you are encouraged to do that. Even your minor contributions such as typo fixes
count. The source code of the website can be found on Github. Your contributions can be:</p>
<h2 class='text-2xl font-bold mb-2'>How can I update an existing roadmap?</h2>
<p class='mb-3'>Please have a look at the <a href='https://github.com/kamranahmedse/developer-roadmap/blob/master/contributing.md' class='font-bold underline' target='_blank'>contribution docs</a> for details.</p>
</div>

<ul>
<li>Adding a new roadmap</li>
<li>Updating existing roadmap</li>
<li>Suggesting changes to the existing roadmaps</li>
<li>Writing a Guide</li>
<li>Updating an existing guide</li>
<li>Fixing grammar mistakes, typos on the website or the content</li>
<li>Updating the UI of the website</li>
<li>Refactoring the codebase</li>
<li>Becoming a sponsor</li>
</ul>

<p>Just make sure to follow the contribution guidelines when you decide to contribute.</p>
<div class='mb-5'>
<h2 class='text-2xl font-bold mb-2'>How can I add content to existing roadmaps?</h2>
<p class='mb-3'>Please have a look at the <a href='https://github.com/kamranahmedse/developer-roadmap/blob/master/contributing.md' class='font-bold underline' target='_blank'>contribution docs</a> for details.</p>
</div>

<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>Can I redistribute the content?</h2>
<h2 class='text-2xl font-bold mb-2'>Can I redistribute the content?</h2>
<p>No, the license of the content on this website does not allow you to redistribute any of the content on this
website anywhere. You can use it for personal use or share the link to the content if you have to but
redistribution is not allowed.</p>
</div>
<div class='mb-5'>
<h2 class='text-3xl font-bold mb-1.5'>What is the best way to contact you?</h2>
<p>Tweet or send me a message @kamranahmedse or email me at kamranahmed.se@gmail.com. I get lots of messages so
<h2 class='text-2xl font-bold mb-2'>What is the best way to contact you?</h2>
<p>Tweet or send me a message <a class='underline font-bold' href='https://twitter.com/kamranahmedse' target='_blank'>@kamranahmedse</a> or email me at
<a class='underline font-bold' href='mailto:kamranahmed.se@gmail.com' target='_blank'>kamranahmed.se@gmail.com</a>. I get lots of messages so
apologies in advance if you don't hear back from me soon but I do reply to everyone.</p>
</div>
</main>
Expand Down

0 comments on commit 1b089c5

Please sign in to comment.