Template:Howcanihelp

From Archiveteam
Jump to: navigation, 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}}}.

Some additional information
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.

Donating to the Internet Archive

Content downloaded by the ArchiveTeam will be uploaded to the Internet Archive, where it will be stored and be available – hopefully – forever. However, storing it costs thousands of dollars in the long run. So, if you can afford, please consider donating to the Internet Archive, so that this piece of history can be kept for us all. http://archive.org/donate

Do you like our cause?

If you want to help in other projects, want to learn more about ArchiveTeam, or even help in development in general, navigate to the Main Page of this wiki, from there you can reach a lot of information. The Team consists of volunteers working on the projects in their free time, so helping hands (and resources) are always welcome.