Biggest disadvantage I see on the official documents is they don't contain the hypothetical situation when something is wrong, they are relying on the fact that everything is as it's supposed to be - perfect. That user has perfectly configured system, that user doesn't accidentally break repository or get lost in some process and stuck as they can't continue for whatever reason.
The guide should count on that and display some alternative commands or reasons why some error messages are showing up (especially gerrit is making stuff very hard, sometimes it reject the commit with cryptic reasons) - or git-review is missing the .gitreview file sometimes and doesn't work. These newbie guides should count on that. The expert on git never get in such a situation because they are doing everything correct. So they naturally can't expect this to happen. I know I can edit the current documents but I have no idea how to merge them with document I wrote. We could eventually insert a FAQ into beginner guide that contain "Why am I getting error X, Y" etc with explanation why it happens and how to fix it. On Wed, May 8, 2013 at 7:49 PM, Yury Katkov <katkov.ju...@gmail.com> wrote: > On Wed, May 8, 2013 at 8:34 PM, Petr Bena <benap...@gmail.com> wrote: > >> Hi, >> >> Long time ago when I started learning with git I decided to create a >> simple guide (basically I was just taking some notes of what is >> needed). I never thought that it could be useful to anyone so I never >> announced it anywhere. However I got some feedback to it, so I decided >> to inform you too. >> >> The basic idea is to create a TOTALLY SIMPLE guide that git >> illiterates like me can understand and thanks to which they would find >> out how to do stuff in wikimedia git / gerrit. >> >> Link is here: www.mediawiki.org/wiki/User:Petrb/Git_for_idiots > > I love it! > > I've written something similar for myself as well: just a bunch of > copy+paste commands for those who use Git once in two months. > >> >> >> It doesn't contain so much and there are some mistakes / feel free to fix >> them. >> >> Since wikimedia switched to gerrit from svn I have yet met a tons of >> people who had problems adapting to it, so this could eventually help >> some. >> >> _______________________________________________ >> Wikitech-l mailing list >> Wikitech-l@lists.wikimedia.org >> https://lists.wikimedia.org/mailman/listinfo/wikitech-l > _______________________________________________ > Wikitech-l mailing list > Wikitech-l@lists.wikimedia.org > https://lists.wikimedia.org/mailman/listinfo/wikitech-l _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
