Jump to content

Topic on Talk:Gerrit/Archive 2

Krinkle (talkcontribs)

Replacement for our Subversion landing page. Use of subpages.

  • Describe what git is, link to more info
  • How are we using git, link to appropriate workflow documents describing how you clone repo, make change, push it, get it reviewed.

Preferred page layout:

  • Git - landing page, very very broad overview
    • Git/Guide - Basic guide to using git. But lets not duplicate docs elsewhere on the web -- keep this appropriate for our users and link generously to outside resources
    • Git/Workflow - describe the workflow for core && extensions (git-review docs here provided we use it)
    • Git/Conversion - move all conversion-related docs here for consistency

This post was posted by Krinkle, but signed as Sumanah.

Qgil-WMF (talkcontribs)

Even simpler proposal:

  1. Merge the content of this page and Gerrit
  2. Make this page a #REDIRECT to Gerrit

And then go through the pages under Git/ and either rename to /Gerrit or merge/clean.

Rationale:

We don't need much Git documentation. It is generic and exists elsewhere. The basic Git steps are explained in our Git/Workflow. The rest can be linked.

Most of the documentation we need refers to our code review process, and we can organize that under Gerrit/ . Generic Gerrit documentation also exists elsewhere and we can simply link to that.

Then we have a bunch of content created during the review process and the first days of Git/Gerrit at Wikimedia. A lot of that is simply not very useful or redundant today.

After all that is cleaned we probably won't even need to have 2 extra nav bars.

This post was posted by Qgil-WMF, but signed as Qgil.

Qgil-WMF (talkcontribs)

Git is now a redirect to this page. Template edited accordingly. Key Git/ pages moved to Gerrit/ (maybe more will be moved as they show up).

What we have:

  • Gerrit - needs to be more useful and beautiful.
  • Gerrit/Getting started - a shorthand guide.
  • Gerrit/Tutorial - Extended play.
  • Gerrit/Workflow - I have been removing content duplicated with the Tutorial. Next is also duplication with the Code review guide. What will remain is probably a mix of advanced / troubleshooting tips (and we might just want to call it like that, we'll see).
  • Gerrit/Code review - I want to split a guide for pure reviewers (+1 people, all of us) from anything related with +2 and merging. Currently everything is mixed there, with big duplication with Tutorial and Workflow.

There are dozens of pages more, but I believe the basic ones are there, and you can reach the other relevant & updated from these.

This post was posted by Qgil-WMF, but signed as Qgil.

SPage (WMF) (talkcontribs)

Your explanation helps. Gerrit/Workflow is now Gerrit/Advanced usage, which makes sense. Thanks for cleaning this up!

I fixed the tutorial links on the developer hub page, but it still discusses Git and Gerrit separately. (And it's dead passive voice, "Code review is performed on Gerrit").

This post was posted by SPage (WMF), but signed as S Page (WMF).

Qgil-WMF (talkcontribs)