Page MenuHomePhabricator

Need better documentation for how to checkout all extensions (for developers)
Closed, ResolvedPublic

Description

From a cursory glance on mediawiki.org at least, it doesn't seem that the process of checking out extensions is very well documented (or clearly).

We have clone-all.php in svn, mediawiki/extensions.git as a repo, then needing submodule init...

Something should be near https://www.mediawiki.org/wiki/Git/Workflow#Clone_the_repository to describe extensions; they're quite important to us!


Version: unspecified
Severity: normal

Details

Reference
bz37977

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 12:29 AM
bzimport added a project: Gerrit.
bzimport set Reference to bz37977.
bzimport added a subscriber: Unknown Object (MLST).

(In reply to comment #1)

To get all at once (for developers) we need docs indeed.

^

By 'for developers' do you mean cloning over ssh?

I'm not sure that's necessary, if people are using git-review then that sets them up properly doesn't it?

We have no (obvious) documentation that tell "a developer" (or anyone else for that matter, ie anon http checkout) how to simply get a copy of all the mediawiki extensions in our git repository

So add docs or fix the docs on mw.org? I'm not at all sure why we need a bug open for this.

(In reply to comment #5)

So add docs or fix the docs on mw.org? I'm not at all sure why we need a bug
open for this.

Cause we've got numerous ways of doing it... Scripts in SVN, scripts in git.

Which is the "right" or "recommended" way?

This is per a discussion between Tim and I when sorting out the extension distributor
<TimStarling> am I meant to check out each extension separately?
...
<TimStarling> I think I set up my laptop before it existed, I just used some shell one-liner with gerrit ls-projects

(In reply to comment #6)

(In reply to comment #5)

So add docs or fix the docs on mw.org? I'm not at all sure why we need a bug
open for this.

Cause we've got numerous ways of doing it... Scripts in SVN, scripts in git.

Delete them? I never asked anyone to write them and they just confuse people. The only script I need is update-extensions.sh, which is designed to update the submodules in the meta repo.

Which is the "right" or "recommended" way?

If you only need one or two extensions, just clone them. If you want most/all of them, clone the meta repo then git submodule update --init

Good enough I'd say. Marking fixed.