From 1b089c58b2c5816e33460e93f3be769a35a5870a Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Mon, 21 Nov 2022 15:09:09 +0400 Subject: [PATCH] Add about page --- bin/readme.md | 12 ----- contributing.md | 63 +++++++++++++++++++++++ src/_includes/components/footer.njk | 6 ++- src/about.njk | 79 +++++++++++++---------------- 4 files changed, 101 insertions(+), 59 deletions(-) delete mode 100644 bin/readme.md create mode 100644 contributing.md diff --git a/bin/readme.md b/bin/readme.md deleted file mode 100644 index a6feb3e5d1..0000000000 --- a/bin/readme.md +++ /dev/null @@ -1,12 +0,0 @@ -## Scripts - -## Migrating Old Guides - -* Copy guides.json to ./data/guides.json -* Copy guides files to ./src/guides -* Run `node bin/migrate-guides.js` - -## Migrating Old Content - -* Copy roadmap content files to the relevant roadmap inside ./src/roadmaps/content -* Run `node bin/migrate-content.js` diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000000..af13c87742 --- /dev/null +++ b/contributing.md @@ -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 + Free Content + ``` + +* Use `BadgeLink` tag for the resource links with below guidelines + + ```html + + React Website + + + The Beginner's Guide to React + + + Understanding React's UI Rendering Process + + + What is DNS? + + ``` + +## Guidelines + +-

Adding everything available out there is not the goal!
+ 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.

+-

Do not add things you have not evaluated personally!
+ 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?

+-

Create a Single PR for Content Additions

+ 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 diff --git a/src/_includes/components/footer.njk b/src/_includes/components/footer.njk index e05fb24341..488c3828c9 100644 --- a/src/_includes/components/footer.njk +++ b/src/_includes/components/footer.njk @@ -30,9 +30,11 @@

© roadmap.sh · - Terms + FAQs · - Privacy + Terms + · + Privacy

diff --git a/src/about.njk b/src/about.njk index a3a4bd12c0..2130d153f7 100644 --- a/src/about.njk +++ b/src/about.njk @@ -43,75 +43,64 @@ tags:
-

What is roadmap.sh?

-

roadmap.sh 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.

-

It started as a set of visual charts on GitHub 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.

+

What is roadmap.sh?

+

roadmap.sh 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.

+

It started as a set of visual charts on GitHub 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.

-

Can I trust roadmap.sh?

-

It's 6th most starred opensource project, visited by hundreds of thousands of developers every month. All the roadmaps are created and reviewed by community and several subject matter experts.

+

How are roadmaps created?

+

+ The project has a strong community that powers everything on the website. It is the 6th most starred opensource project on GitHub 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. +

-

What are the plans for roadmap.sh?

-

The website started off as simple repository containing a few charts 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.

-

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.

+

What are the plans for roadmap.sh?

+

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.

-

How did you build roadmap.sh?

-

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.

+

How is roadmap.sh built?

+

The website is built with Eleventy and Tailwind and is deployed to GitHub pages. The project is fully open-source and the codebase + can be found on GitHub

-

How does it make money?

-

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.

-

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.

+

How can I add a new roadmap?

+

For new roadmaps, please open an issue with the textual description of the roadmap in the form of bulleted list. Here is an example contribution of a new roadmap.

+

Find more details in the contribution docs.

-
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. -
-
-

Can I contribute?

-

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:

+

How can I update an existing roadmap?

+

Please have a look at the contribution docs for details.

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

Just make sure to follow the contribution guidelines when you decide to contribute.

+
+

How can I add content to existing roadmaps?

+

Please have a look at the contribution docs for details.

+
-

Can I redistribute the content?

+

Can I redistribute the content?

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.

-

What is the best way to contact you?

-

Tweet or send me a message @kamranahmedse or email me at kamranahmed.se@gmail.com. I get lots of messages so +

What is the best way to contact you?

+

Tweet or send me a message @kamranahmedse or email me at + kamranahmed.se@gmail.com. I get lots of messages so apologies in advance if you don't hear back from me soon but I do reply to everyone.