Authoring Documents for www.irchelp.org
This is an early draft of this guide, documenting the new way we’re going to maintain www.irchelp.org. Suggestions are welcomed. Unless otherwise noted, this really isn’t set in stone yet, so now is the time to give your input!
This site is run by a group of volunteers primarily consisting of the ops from the #irchelp channels on EFNet and freenode. We welcome contributions to the site, but have a number of guidelines which you should follow so that your content can be easily included into the site.
As of 2012, all content on the site is maintained as Markdown files with a short YAML header containing metadata. Markdown is a simple way of adding formatting to text files, very similar to wiki markup.
Our public git repository is located at https://github.com/irchelp/irchelp.github.io
The Git repository is very important to this process - it’s the part that will allow multiple editors access to update the site, without risk of stepping on each other’s toes, and which will allow us to easily roll back unwanted changes.
The document header (YAML Front Matter) is written in YAML, and delimited with three dashes. It is a simple list of name: value pairs that describe each document. These headers will be used in templates.
A sample header follows:
--- title: Document title author: random-irchelper datecreated: 1 September 1993 dateupdated: 30 November 2012 status: (this is optional, but I'm going to add hooks that put a warning message about depreciated content if the status is "historical") layout: default license: (see below under legal requirements) summary: > This is a long summary with multiple lines. This is also optional. Each line is indented in the same way. When the indentation stops, so does the summary. ---
Note the — at the beginning and end of the header. This seperates the header from the content, and is required for Jekyll to recognize this as a header. The header is not Markdown formatted, so most other Markdown parsers will not format it.
Everything but the title: and layout: values are technically optional, but documents must have the YAML Front Matter prepended to them for Jekyll to recognize them as files it should process.
Several programs are useful to irchelp.org authors.
- retext is a graphical editor with live preview for Linux systems (available in the Ubuntu repositories as retext).
- Atom is a powerful GUI text editor for many platforms, including Windows, Mac, and Linux, with syntax highlighting and a number of plugins such as Markdown Preview Plus available to make working with Markdown easier for authors.
- Jekyll is used to process the Markdown files into finished HTML documents. You don’t need this to author documents, but it’s useful if you want to preview them exactly as they will look on the actual website.
- GitHub Desktop is available for Windows and Mac, and provides an easy to use interface to our Git repository on Github. The standard commandline git client is also bundled along with a suite of basic Unix text handling utilities.
- TortoiseGit integrates Git functionality into Windows Explorer, making it easy to see the status of your files and making Git functions available on right click menus.
- Git is necessary to read/write the repository which stores the source to the website. Clients are available there for virtually all operating systems, not just Linux :)
This list is by no means comprehensive, but it’s a good starting point for authors looking for tools.
- We are not a software hosting site. No executables or archive files will be hosted - links should be provided to landing pages for stable and canonical download locations for any software mentioned on the site.
- We are aiming to be as network-agnostic as possible. In the past, IRCHelp.org was EFNet and IRCNet centric, we are in the process of changing that.
- We do not, and will not ever advertise. We are not a promotional site, and we aim to be fair and objective in our treatment of IRC Clients, other software, and IRC Networks.
Most of our current content was either authored by IRCHelp channel ops specifically for irchelp.org and made available on an “all rights reserved” basis, or used by permission, and we do not have the rights to relicense it.
Going forward, in the interests of license clarity, as well as to protect ourselves from any legal trouble and avoid having to scramble to remove articles, we need to have clear rights to use all content on irchelp.org.
There are two options for this:
- the first, and preferred way is for content to be licensed under terms that permit anyone to use it - public domain or an acceptable free documentation license
- Alternatively, the content may be provided to irchelp.org under a release that grants us a non-revocable right to publish it.
The preferred license for new irchelp.org content is the Creative Commons Attribution-ShareAlike 4.0 International (CC-B4-SA) license. This license requires that the license be preserved intact when reusing or republishing content, and that content must be attributed back to original authors.
In any case, content must either be your own work, so that you have a clear right to license it, or it must already be under an appropriate free documentation license.
- GFDL with no invariant sections
- Public Domain
Other Acceptable Licenses
Other licenses that we find acceptable include any of the following:
- Older revisions of any of the preferred creative commons licenses or GFDL
- GFDL with invariant sections, subject to the editorial acceptability of the invariant sections.
- Modified (“3 clause”) BSD License
- Simplified (“2 clause”) BSD License
Other licenses may prove to be acceptable, but we will need to evaluate these on a case-by-case basis in the future.
Acceptable under Special Circumstances
- All rights reserved to irchelp.org (acceptable for older work)
- Used by permission (acceptable for archival documents if no other license terms are available)
The applicable licensing tag should be indicated in the YAML front matter of each document, as one of the following values.
- cc-by-4 - The document uses the Creative Commons Attribution 4.0 International license and may be freely used and distributed so long as the attribution remains intact.
- gfdl-1-3 - The GNU Free Documentation License, version 1.3
- cc-zero - Works dedicated to the Public Domain using the Creative Commons Zero dedication.
- publicdomain - works dedicated to the Public Domain with a simple disclaimer
- usedbypermission - The document was provided by an outside contributor under permission.
- irchelp - The document was authored by IRCHelp chanops, and has only been licensed for use on irchelp.org. It may not be used on other sites without permission.