diff --git a/contributing/guide.md b/contributing/guide.md deleted file mode 100644 index 90fa3d8a2..000000000 --- a/contributing/guide.md +++ /dev/null @@ -1,14 +0,0 @@ -## Submitting a Guide - -First thank you for considering contributing to this project. It wouldn't have been possible for us to keep it live without your contributions 🙏 - -> Follow the steps listed below in order to add a new guide - -* Fork this repository -* If you haven't contributed to this project before then create your author profile - * Open the file [authors.json](../content/authors.json) - * Put your preferred `username` - * Put a profile picture in [authors directory](../public/authors) with the username -* Create a new markdown file in the [guides directory](../content/guides). -* Add the metadata for this guide in [guides.json](../content/guides.json). Please note that `fileName` and `slug` must match. -* Open a pull request diff --git a/contributing/readme.md b/contributing/readme.md index 7753dd5ef..8d0624764 100644 --- a/contributing/readme.md +++ b/contributing/readme.md @@ -1,14 +1,11 @@ ## The Goal * For the roadmaps, we encourage you to discuss and contribute with new roadmaps. For the existing ones, please note that our goal is to not have the biggest list of items. Our goal is to have a list of items or skills most relevant today. -* For the guides, please pick a topic, open an issue or reach out on twitter [@kamranahmese](https://twitter.com/kamranahmedse) to get the go-ahead and [start writing](./guide.md). -* For the resources, we are still preparing the contribution guidelines but submit them in an issue for now. Just note that the resources are *highly opinionated* and *curated*. Your opinion on value of any resource may not match the opinion of curator. +* For the resources, please note that they are *highly opinionated* and *curated*. Your opinion on value of any resource may not match the opinion of curator. ## Contributing * [Submitting roadmaps](./roadmap.md) -* [Writing a Guide](./guide.md) -* [Submitting resources](./resources.md) **No PR will be discarded without explanations!** diff --git a/readme.md b/readme.md index 059b739e6..b053e06ca 100644 --- a/readme.md +++ b/readme.md @@ -29,10 +29,6 @@ > The purpose of these roadmaps is to give you an idea about the landscape and to guide you if you are confused about what to learn next and not to encourage you to pick what is hip and trendy. You should grow some understanding of why one tool would be better suited for some cases than the other and remember hip and trendy never means best suited for the job. -

Note to Beginners

- -> These roadmaps cover everything that is there to learn for the paths listed below. Don't feel overwhelmed, you don't need to learn it all in the beginning if you are just getting started. We are working on the beginner versions of these and will [release it soon](https://roadmap.sh) after we are done with the 2021 release of the Backend and DevOps roadmaps. - *** ## Available Roadmaps @@ -68,9 +64,9 @@ npm run dev > Have a look at [contribution docs](./CONTRIBUTING.md) for how to update any of the roadmaps -* Add new Roadmap -* Suggest changes to existing roadmap -* Improve the site's codebase +- Add new Roadmap +- Suggest changes to existing roadmap +- Improve the site's codebase - Write tests - Discuss ideas in issues - Spread the word