Talk:Gerrit/Tutorial/tl;dr

Previous page history was archived for backup purposes at Talk:Gerrit/Getting started/LQT Archive 1 on 2015-07-10.

Step #1 of tl;dr says: "Install git-review". This is *before* creating a new SSH key (step #2) and creating a developer account (step #3).

BUT, according to the instructions at the target "install git-review" link, BEFORE you are ready to install git-review, you should create a gerrit user account, set up an ssh key (3, 4), and clone a project repository.

Having already done steps 2 and 3 before doing step 1 makes tl;dr steps 2 and 3 redundant.

done; new code at least must be functional before check in.

"When the code is ready:...", i dont see a step between writing the code and comitting. A test step should be evoked (with page link on how to test) avoiding reviewers to validate possibly not operational code. -- Christian 🇫🇷 FR (talk) 08:13, 23 August 2023 (UTC)

Change "Now you can edit the code to make your changes" to "Now you can edit the code to make and test your changes"? :)

thanks.

I have tried but unfortunately current version still exceeded "one printed page" requirement (several lines are on the second page, Letter, Timeless skin as it is the shortest). Hope someone could make it even shorter.

Where does "one printed page" requirement come from?

There is a comment after languages tag - seems it was here since the creation of this page: Please keep the length of this page under one printed page. There are other pages for longer guides.

Yes, back when I wrote it, there was another guide, and everyone complained that it's too long. So someone wrote a simpler guide, but it ended up being just as long. So I wrote one that is intentionally short! :)

Noone shall add or remove content because of a "some undefined size of some dead tree" statement.

I agree that the "printed page" requirement is arbitrary, but IMO it makes sense to have some limit to ensure the page doesn't keep growing little by little. Perhaps number of characters, or words, or page length in bytes? The latter is readily available from the page info overview, which would make it convenient to check.

when i run git clone ssh://qdinar@gerrit.wikimedia.org:29418/mediawiki/core.git mediawiki i get : " The authenticity of host ... can't be established. RSA key fingerprint is ....". i asked about this in irc and i got this answer: " this is the right fingerprint https://wikitech.wikimedia.org/wiki/Help:SSH_Fingerprints/gerrit.wikimedia.org:29418 " " https://wikitech.wikimedia.org/w/index.php?title=Help%3ASSH_Fingerprints%2Fgerrit.wikimedia.org%3A29418&type=revision&diff=1908069&oldid=1872718 ". then i compared fingerpints and typed yes, enter. i think this may help somebody.

See Gerrit/Troubleshooting instead.

what did you mean? if you mean i should look there first instead of googling, if i looked it, then this thing is not there. for example, there is no keyword "authenticity". also, i did not know that page exist. so, googling is easier. if you mean, i should add this post to that page's discussion, then, i think, probably editors of that page review this discussions in order to see possible problems and add about them on that page.

whole version of this tutorial does not explain either. why ldap password is needed? may be it is not required? for what it can be used?

@Qdinar Where does some page (which one) talk about an "LDAP password" (!) at all? Please be more specific. Also note that the terms "LDAP account", "account on wikitech.wikimedia.org", "account on gerrit.wikimedia.org" are more or less the same thing in this context.

the page this discussion is for. quote: "Also add your public key to LDAP using any of: the wikitech NovaKey page * toolsadmin interface". thank you for saying that gerrit account is same with wikitech account. i thought that i am not registered there. and, i have found my mistake. it is not ldap password, but ldap key. is not it the same key which i added in https://gerrit.wikimedia.org/r/settings/ ? i will check by myself. i see that https://toolsadmin.wikimedia.org/profile/settings/ssh-keys/ is empty. and https://wikitech.wikimedia.org/wiki/Special:NovaKey is also empty. and btw i have found out that https://toolsadmin.wikimedia.org/auth/login/ says "ldap username" and "password".

@AKlapper (WMF), can you say (do you know?), why ldap key, or keys for pages https://toolsadmin.wikimedia.org/profile/settings/ssh-keys/ and https://wikitech.wikimedia.org/wiki/Special:NovaKey are needed? are they all same?

done; clear explaination.

Please what is the meaning of /tl;dr in Gerrit/Tutoriel/tl;dr ?

Any other one more adapted ?

Thanks.

https://en.wikipedia.org/wiki/Wikipedia:Too_long;_didn%27t_read :)

Too long; didn't read

Short version for people who don't need to read the whole tutorial (they know most of it)

After the page was renamed, we need to narrow links leading to Gerrit/Getting started. Either to Gerrit/Tutorial/tl;dr or to Gerrit/Tutorial, it depends on the context for every link. It is pretty simple to narrow them here on mwwiki, but it will be harder to narrow links from content wikis, wikitech, meta, etc. So any help appreciated!

Under git-review 1.25.0, I'm now getting a "Using global/system git-review config files (.config/git-review/git-review.conf) is deprecated" with each review push. What's the best solution? Move defaultremote=origin into each repo's .gitreview file, a la https://gerrit.wikimedia.org/r/224872?

Have you got multiple remotes, where some are ssh and some aren't ?

This comes a bit late but in case it might help someone, the Tutorial#Configuring_git-review section has been updated to reference the new way. Just run this command instead of using the file:

git config --global gitreview.remote origin

Moved

Hello, I propose to move this page to a better name. The name is a little bit confusing as novice users usually expect "getting started" to be a good novice tutorial. But for this purpose we have got /Tutorial page. And on this page are more likely an instructions for at least a little experienced users, some tl;dr of /Tutorial for those, who know, what to do, what these commands mean, just don't remember them, right?

I am not a good english speaker, so I don't know, how to say my suggested name in english, so I'll try to explain those czech words to english: something like "notes/lists of commands/methods usually used for working with Gerrit" (or something like "tl;dr" or "basic usage" or "short guide" or something)

https://phabricator.wikimedia.org/T161901 might be of interest.

Well, at least this Tutorial I used as a novice user and this Getting started I use now as an experienced user as perfect. I wish some similar approach would be created also for Toollabs.

try https://wikitech.wikimedia.org/wiki/Help:Getting_Started ?

Tried, was not successfull, that tutorial is not really well written :/

how about https://wikitech.wikimedia.org/wiki/Help:Cloud_Services_Introduction ?

This is more like an intro than good novice tutorial and how-to guide. I tried to use Toolforge according to those tutorials unsuccessfully, but there is going to be some Toolforge workshop by Czech Wikimedia, so I'll learn to work with Toolforge there and then try to improve these tutorials to be usable for people like me: really technically based/knowledged/experienced people, who don't understand manuals provided and who would really use the service if know how to. But off-topic

Sigh.

I created this page in 2012 when MediaWiki was transitioning from SVN to Git. Back then, a lot of people, including myself, were not familiar with Git, and even fewer people were familiar with Gerrit. The page "Gerrit/Workflow" was written, but people complained that it's too long, because it was about 20 pages in print (since then it was quite appropriately renamed to Gerrit/Advanced usage). So somebody wrote Gerrit/Tutorial, with the purpose of being a simpler page. Unfortunately, that page also quickly grew to about 20 pages in print.

So I created this page with the intention of being a very short Git manual, which would give the most basic and frequently-needed commands, and link to other pages for more advanced or rarely needed info. In the invisible HTML comment at the top I wrote that it must remain under one page in print. To match this purpose, I called it "Git/TLDR".

I don't know why was it renamed to "Gerrit/Getting started".

I'm biased, of course, but I support moving it back to "Git/TLDR".

I'm fine with Gerrit/TLDR.

Moved, as it is mostly tl;dr of the Tutorial, I moved it as a subpage of it.

points to https://help.github.com/articles/set-up-git which suggests to Download GitHub for Windows but using this Windows-Client, is it possible to contribute to MediaWiki?

We (qa/browsertests) have at least one contributor working on Windows. Why do you think that would not be possible?

This post was posted by ZFilipin (WMF), but signed as Zeljko.filipin(WMF).

Yes.

@Zeljko.filipin: He's asking specifically whether it is possible to contribute to MediaWiki repositories (which are hosted with Gerrit) from the GUI app "GitHub for Windows" (not general Git command-line for Windows). It's understandable that that app might not be capable of interacting with non-GitHub repositories, though afaik that works fine. Note though most manuals all assume git command line, so even if it would work, you may want to stick with that for having lots of plugins and documentation to choose from (and other people who can help).

@Krinkle: thanks for the explanation.

I was pairing (remotely) with our OPW intern Rachel recently and she made a commit from Github for Windows app. As far as I remember the app did not add Change-Id to the commit message so Gerrit complained when she tried to push code there. Github for Windows is easy to install and has a good diff tool, but I would not recommend it for committing. The app will create Git Shell shortcut on desktop during the installation. I would recommend using Git Shell for committing.

This post was posted by ZFilipin (WMF), but signed as Zeljko.filipin(WMF).

Yuvipanda suggested committing to GitHub and G2G would care about the remaining parts. This seems to be convenient to me. (Currently I am using Linux VMs, that also worked fine but they always take ages to load).