What is a wiki?
A wiki is a special kind of website that provides a place for collaborative working. Anyone (with a login) can edit it - for example, add or remove content, move pages around and change the organisation, upload additional media (images, other types of file attachments).This particular wiki uses a software calledwiki.js
. It is a very powerful piece of software with lots of capabilities that you can read about on the wiki.js website.
The wiki.js documentation contains a complete online guide to editing and managing wiki.js wikis.
If you don't yet have a login for this wiki, please contact one of the Theme Leads (you can read more about the Themes below) who should be able to help you get an account.
The js.wiki
software we use is very similar to other types of wiki software, but has a few particularities. This page tries to provide some useful site-specific information and to answer some frequently asked questions.
We have tried to structure to the wiki so that it is as open as possible while at the same time providing areas that are more restricted to members of the community.
Each Theme has a defined area to contain pages related to their area of work - for example, meeting notes, to do lists, discussion pages, draft pieces of work, etc. By default, all pages in this wiki are publicly accessible to read. However, only authenticated users of the wiki (including both Voting Members and Non-Voting Members) can edit pages.
Each Theme section can also contain pages that are not able to be read by the public. These are, however, readable by any member of the community who has a login to the wiki (i.e. by both Voting and Non-Voting Members). In order to create such a page, it needs to be named as such:
<theme>/private/PageName
Where <theme>
is one of the Theme areas (listed on the front page and below) and PageName
is the name you've chosen for the page you are creating.
Theme areas are as follows:
/en/infrastructure-dev/
/en/opmanag/
/en/statdev/
/en/education/
/en/governance/
/en/comms/
You will notice that each of the Theme areas described above is preceded by /en/
- representing the English (language) locale. There is potential for this wiki to include other languages, however, for the moment, we are only using the /en/
locale for this wiki. Normally, the locale will be automatically added for you when you create a page.
Currently, there are three other areas of the wiki:
/coregroups/
/steeringcommittee/
/advisoryboard/
There are also a few other pages (for example, this one!) that are included in the about
area of the wiki. These can be less-specific pages that are generally useful and/or contain information applicable to multiple other areas of the wiki, or they are pages that describe what DataSHIELD and the community are about.
It is likely in the future that other areas of the wiki will organically develop - for example, the Education Theme area of the wiki is for organising and documenting the work and activities of the Education Theme, but actual education topics (such as learning materials) might be placed somewhere else (for example, in an area dedicated to the DataSHIELD release that those learning materials relate to).
(not answered yet)
Remember to assign tags!
This is one of the peculiarities of js.wiki
: you don't.
What you do is just create the page however you like - for more info, see https://docs.requarks.io/guide/structure
The key thing to bear in mind, though, is to make sure that your page is finadble. For example, if you create a new page somewhere, you probably want to go back to an index/main page (e.g. the front page, or the main page for whichever is the most relevant Theme) and make sure there is a link to your new page. Otherwise it's difficult for people to find it!
The best way to find what you're looking for is to use tags.