Page MenuHomePhabricator

Installation part is missing in README.md in wiki extension MassMessage
Closed, DeclinedPublic

Description

In README.md file Installation part is missing where as in another extensions like Short-Url and other wiki extensions Installation part is present. Users can find relatively easy if Installation part is present in README.md

Event Timeline

Gopavasanth renamed this task from Installation part is missing in README.md in wiki extension Massmessage to Installation part is missing in README.md in wiki extension MassMessage.Mar 30 2018, 7:00 AM

Change 423086 had a related patch set uploaded (by Gopavasanth; owner: Gopavasanth):
[mediawiki/extensions/MassMessage@master] Installation part is missing in README.md in Wiki extension MassMessage

https://gerrit.wikimedia.org/r/423086

@Legoktm If this part is present in README.md then this will help users more and also this same part is present in another wiki extensions in README.md file.

@Gopavasanth I think @Legoktm is correct. Already documentation to installation is provided in the link. And I guess no other extensions have installation specified in their README.md files (please do specify if any extensions have it ).

@Rammanojpotla you can also check wiki extensions like LiquidThreads[1], Cargo[2] Installation part is present in README file

[1] https://github.com/wikimedia/mediawiki-extensions-LiquidThreads/blob/master/README
[2] https://github.com/wikimedia/mediawiki-extensions-Cargo/blob/master/README

So I thought of adding Instllation part in wiki extension MassMessage.

Each of the README files has its own specifications I guess. Such as in

[1] https://github.com/wikimedia/mediawiki-extensions-LiquidThreads/blob/master/README

You can see there is no configuration part in above link but Mass message extension has its configuration in README.md. Similarly, there are no sections such as contact, Status etc in Mass message extension README.md but you can find them in README of liquid threads.

Also, in case of Cargo extension, I can't find any installation part at https://www.mediawiki.org/wiki/Extension:Cargo. So, it may have its installation part written in README file.

Each README file has different specifications (are written in a different format). So, I guess this is not needed. However, I am not quite sure of this change.

I can't find any installation part at https://www.mediawiki.org/wiki/Extension:Cargo. So, it may have its installation part written in README file.

For Cargo extension Installation part is also present here https://www.mediawiki.org/wiki/Extension:Cargo/Download_and_installation#Installation,

So again it is also present here https://github.com/wikimedia/mediawiki-extensions-Cargo/blob/master/README

In the same way I wish to implement on MassMessage

@Gopavasanth as I already said you different files have different specifications and I have no much familiarity with this. I guess you can ask the @Legoktm(I think he is the author of this file).

In general, we shall not duplicate information - it will get out of sync. Instead, we shall link to the one place where the information can be found, if at all.

Thanks @Aklapper I agree with you about duplicate information but why do many extension have the same in README file? instead, they can provide the respective link to follow.

In general, maintainers are free to do what they want. In free software there are not 'rules' for everything. And not everybody would follow every rule anyway.
Everybody is free to propose changes (as you did in this task).

Prtksxna subscribed.

I don't see much value in this to be honest...I'd rather just keep all the installation instructions on https://www.mediawiki.org/wiki/Extension:MassMessage.

Change 423086 abandoned by Krinkle:
Installation part is missing in README.md in Wiki extension MassMessage

Reason:
Closing per task.

https://gerrit.wikimedia.org/r/423086