Template:Howcanihelp

From Archiveteam
Revision as of 18:50, 4 October 2014 by Bzc6p (talk | contribs) (A template for projects' "How can I help?" section, with detailed information.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Template for projects' "How can I help?" section.

Insert {{subst:howcanihelp|project_name|project_code_github_id|#irc_channel}} after the ==How can I help?== section, where:

  • project_name is the name displayed in the Warrior and on the tracker,
  • project_code_github_id is the string after https://github.com/ArchiveTeam/ for the project code,
  • irc_channel is the project's dedicated IRC channel (don't forget the #).

For example:

{{subst:howcanihelp|Verizon|verizon-grab|#verizoff}}

I strongly recommend using the subst: prefix, to prevent various problems arising upon the change of this template.

Feel free to improve this template.


Template text:

Running a Warrior

You can start up a Warrior and there select {{{1}}}. (If you don't really care what you are archiving, select ArchiveTeam's Choice instead, as at some points ArchiveTeam may priorize another project.)

Running the script manually

If you use Linux and you're a bit familiar with it, you can try running the script directly.

The instructions can be found at github.com/ArchiveTeam/{{{2}}}.

Don't forget to replace YOURNICKHERE with your nickname.

The number after --concurrent determines how many threads run at the same time. You can increase this number if your resources (RAM, CPU, bandwidth) are sufficient. However, if you constantly see messages about rate limiting, there is no need to increase the concurrency.

If you want to stop the script, please do it gracefully if possible. To do so, create an empty file named STOP in the folder of the script (terminal command: touch STOP). The script finishes the current item(s) and stops only after that. (If you kill the script immediately, the items get broken, and they will need to be reassigned to another user.) – Before starting the script again, don't forget to remove the STOP file.

If you see "Project code is out of date", kill the script, go to its folder (cd {{{2}}}) and issue git pull https://github.com/ArchiveTeam/{{{2}}}. After the updating has finished, re-launch the script.

Joining us on IRC

Either you run the Warrior or the script, you should join our IRC channel {{{3}}} to catch the latest news about the project and its progress, and there you can also put questions if something doesn't work. (In the latter case, please study the Warrior page and/or the script instructions first.) You can use the web interface at http://chat.efnet.org:9090, or if you use a standalone IRC client, connect to irc://irc.efnet.org.