{"id":93089,"date":"2020-09-03T01:42:16","date_gmt":"2020-09-02T23:42:16","guid":{"rendered":"https:\/\/prohoster.info\/blog\/administrirovanie\/awesome-list-svoimi-rukami-ili-github-vmesto-bloknota"},"modified":"2020-09-03T01:42:16","modified_gmt":"2020-09-02T23:42:16","slug":"awesome-list-svoimi-rukami-ili-github-vmesto-bloknota","status":"publish","type":"post","link":"https:\/\/prohoster.info\/en\/blog\/administrirovanie\/awesome-list-svoimi-rukami-ili-github-vmesto-bloknota","title":{"rendered":"Creating Your Own Awesome List, or GitHub Instead of a Notebook","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

\"Creating<\/p>\n

<\/p>\n

Hello, Habr! We all probably have that file where we stash useful and interesting things for ourselves. Some links to articles, books, repositories, manuals. These can be bookmarks in a browser or even just open tabs left for later. Over time, all of this accumulates, links stop working, and a large portion of the materials simply becomes outdated. <\/p>\n

<\/p>\n

What if you share this valuable resource with the community and upload this file to GitHub? Then your efforts could be useful to someone else, and maintaining relevance could be done collectively by accepting updates from willing contributors through the good old PRs. This project is intended for just that. Awesome lists<\/a><\/noindex>is for. It ranks in the top 10 GitHub repositories with 138K stars, and a link to your work could end up right in its main README, attracting a huge audience to your creations. However, it will require a bit of effort. I want to share my experience in such endeavors with you. <\/p>\n

<\/p>\n

My name is Maxim Gramin. At KROK, I work on Java development and research in the field of databases. In this post, I will explain what Awesome Lists are and how to create your own official awesome repository.<\/p>\n

<\/a><\/noindex><\/p>\n

What are Awesome Lists<\/h2>\n

<\/p>\n

When I need to get to grips with a new technology or programming language, the first place I go is here \u2014 I find the relevant section and suitable lists. Judging by the number of stars and their constant growth, I\u2019m not the only one who does this.
\n\"Creating<\/p>\n

<\/p>\n

In fact, it is just an ordinary flat readme.md that lives in a separate the repository<\/a><\/noindex>, currently holding 8th place among all GitHub repositories and including links to other lists dedicated to specific topics. For example, in the Programming Languages section, you can find lists like Awesome Python and Awesome Go, and in Front-End Development, there is an abundance of resources for web development. And, of course, there\u2019s the section Databases<\/a><\/noindex> (which we will return to shortly). And yes, all of this is not limited to just technical topics. For instance, in the Entertainment and Gaming sections, you can find a lot of interesting things (personally, I was pleased by awesome-fantasy<\/a><\/noindex>).
\nThe main feature is that all these lists are curated not by the author alone, but by the community and are compiled according to a special and very strict awesome manifesto<\/a><\/noindex>. Each of these lists is a self-contained community of professionals, living its own life and open to your pull requests, which will make it even better. Additionally, anyone can create their own list if a certain topic has not yet been covered.<\/p>\n

<\/p>\n

The author of the idea and coordinator of all this is the legendary Sindre Sorhus, the first person on GitHub<\/a><\/noindex>the author of more than 1000 npm modules,<\/a><\/noindex>and it is he who will accept your PRs.
\n\"Creating<\/p>\n

<\/p>\n

How to enter the awesome list<\/h2>\n

<\/p>\n

If you haven't found a suitable list on the topic that interests you, that's the first sign that you need to make it yourself!<\/p>\n

<\/p>\n

I'll explain using my own project as an example, Awesome Database Tools.<\/a><\/noindex> In each project, I have to work with various databases, and that's why I created a file where I gathered useful tools for working with them, various DB migrators, IDEs, admin panels, monitoring tools, and so on. Tools that I have already used or was planning to start using. I shared this file with colleagues at KROK and beyond. This helped many and was interesting. Ultimately, I wanted more recognition when I noticed that there was no list on this topic in the Databases section. So, I decided to add mine. <\/p>\n

<\/p>\n

What do you need for this?<\/strong><\/p>\n

<\/p>\n

    \n
  1. Register a regular GitHub repo with a name like awesome-something. In my case, it was awesome-database-tools.<\/li>\n
  2. Bring your list to the awesome format with the help of generator-awesome-list,<\/a><\/noindex>which will generate all the necessary files in the required format.<\/li>\n
  3. Set up a real CI. awesome-lint<\/a><\/noindex> and Travis CI will help us monitor the validity<\/a><\/noindex> of our list.<\/li>\n
  4. Wait 30 days. <\/li>\n
  5. We review at least 2 other people's PRs.<\/li>\n
  6. And finally, make a PR to the main repo, where you add a link to your repo. Here, it's essential to read everything carefully and thoroughly meet all the numerous requirements for the new list and the PR itself.<\/li>\n<\/ol>\n

    <\/p>\n

    My first attempt was unsuccessful.<\/a><\/noindex>
    \n\"Creating
    \nBut some time passed, I gathered even more material, worked on my mistakes, and dared to make a     second attempt.<\/a><\/noindex>.<\/p>\n

    <\/p>\n

    However, I forgot one very important thing, which was gently hinted at to me:
    \n\"Creating<\/p>\n

    <\/p>\n

    I was not very attentive and did not add the unicorn as confirmation that all conditions were met.
    \n\"Creating<\/p>\n

    <\/p>\n

    Then a little more time passed, a few more corrections were made based on the remarks, and the long-awaited tweet<\/a><\/noindex>, announcing that my PR was accepted.<\/p>\n

    <\/p>\n

    That's how I became the author of my first list, and I started receiving PRs<\/a><\/noindex> from the community to add new tools. Many of them are already included in Awesome Database Tools.<\/a><\/noindex>. If you're too lazy to click the link, <\/p>\n

    <\/p>\n

    here's the current list at the time of the post's publication<\/b><\/p>\n

    Awesome Database Tools. \"Creating<\/a><\/noindex><\/h1>\n

    <\/p>\n

    Community driven list of database tools<\/p><\/blockquote>\n

    Here we will collect information about great useful and experimental tools that simplify working with databases for DBAs, DevOps, Developers, and regular users.<\/p>\n

    <\/p>\n

    Feel free to add information about your own db-tools or your favorite third-party db-tools.<\/p>\n

    <\/p>\n

    Contents<\/h2>\n

    <\/p>\n