Last modified: 2014-04-05 01:29:54 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T65125, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 63125 - Add a README
Add a README
Status: NEW
Product: MediaWiki extensions
Classification: Unclassified
Flow (Other open bugs)
unspecified
All All
: Normal normal (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2014-03-26 18:19 UTC by Jon
Modified: 2014-04-05 01:29 UTC (History)
4 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Jon 2014-03-26 18:19:25 UTC
Please add a README file to Flow so that a newcomer like myself can easily get it setup locally with minimal brain usage.

benefits: attract more developers to your project
Comment 1 Erik Bernhardson 2014-03-26 18:28:26 UTC
At the moment the easiest way to get flow going is to use the vagrant role.  I'll distill what it does into a short README as well.
Comment 2 spage 2014-04-05 01:29:54 UTC
The README should say "see http://www.mediawiki.org/wiki/Extension:Flow". We don't have the time to maintain documentation in multiple places, the extension page is the one canonical place for it.

The only viable approach is to have the Makefile do

curl 'http://www.mediawiki.org/wiki/Extension:Flow?action=raw' | \
    sed '1i See http://www.mediawiki.org/wiki/Extension:Flow for latest info, its contents at one point were:\n\n' > README.txt

I've mentioned MediaWiki-vagrant enable-role flow on that page.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links