Child pages
  • Quick Guide for Wiki Space Administrators

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image AddedQuick Guide

...

This guide is based on the similar guide of Helsinki University

Tämä ohje pohjautuu Helsingin yliopiston vastaavan ohjeeseen, http://wiki.helsinki.fi/x/1gw.

Table of Contents
minLevel2
stylenone

1. Wikialueen perustaminen

First check rules of TKK wiki serviceTarkista ensin TKK:n wikipalvelun pelisäännöt! Mieti sitten tarvitsetko oman henkilökohtaisen wikialueen vai haluatko alkaa ylläpitämään jonkin työryhmän tms. yhteistä wikialuetta:

  • Henkilökohtaiset wikialueet luodaan omalta profiilisivulta, kts. tarkemmin kaikkien käyttäjien pikaoppaasta
  • Yhteistyö wikialueita (nk. globaaleja alueita) voivat luoda TKK:n työn tekijät. Luonti tapahtuu Create Space työkalulla.

2. Valmistele wikialue käyttöä varten

Yhteinen wikityöskentely käynnistyy paremmin jos ensin hieman valmistelet wikialuettasi:

...

titleLinkkivinkki

...

Please read more about the new features in Aalto Wiki version 5!

Panel

Click the images for a bigger version.

1. Setting up a Wiki Space

Info

A Wiki Space is a collection of web pages about a topic, project, course etc. To create content in Aalto Wiki you must first create a Wiki Space for it.

 

First check the rules of Aalto Wiki! Then consider whether you need a personal Wiki space or if you want to start administering a Wiki global space of, e.g. a working group.

  • Personal wiki spaces are created from the user menu (your username in the top right part of the window) and choosing Create Personal Space, for details see Quick Guide for Wiki Users.
  • Collaborative wiki spaces can only be created by Aalto employees and students, using the Create a Space tool.

2. Creating A Wiki space

You can create a Wiki space you can go to Aalto Wiki frontpage (dashboard) and click Create Space button:

Image Added

From here you can choose what kind of a Wiki space to create. Personal wiki space is for you own personal use, but you can change the permissions later on. Other space types are inherently open to other users as well.

Image Added

There are now four different wikispace types. These types are intended for different kind of collaboration.

  1. Blank Space - the default blank space without any ready made features
  2. Documentation Space - a space with ready made features for documenting 
  3. Knowledge Space - a space for faq:s resources and best practises
  4. Team space - a space design for project teams and collaboration teams

The type of the space will affect on the way content is stored in the space. If you are now sure what kind of collaboration you are using the space for, create a Blank space.
More information about spaces : https://confluence.atlassian.com/display/DOC/Working+with+Spaces

Next you will have to give your wiki space a name, and a space key. 

Image Added

The Space name is the "Title" of your wiki space, and can be changed later on.

The Space key is a shortname for the space and is a part of the URL to the wiki space, this cannot be changed later and has to be unique.

Info

If you want the wiki space to be for personal use, or you want to create content for your wiki pages first choose the "Visible only to me".

 

2. Preparing the Wiki Space for Use

The launch of your global wiki space will go more smoothly if you prepare your Wiki space first:

  1. State the purpose of the wiki space briefly and clearly: why it exists and what it is meant for. Encourage users to participate in creating and modifying pages; do not make pages 'too complete'.
  2. Add specific instructions in the space and provide links to additional instructions. You can also link into the existing Aalto Wiki instructions, or into Atlassians Confluence -instructions.
  3. It is also worth defining the copyrights of the material to be created in the space. 

    Tip
    titleUseful links:

    Wikipatterns offers clear instructions that facilitate wiki adoption: http://www.wikipatterns.com

3.

...

Managing User Groups and Permissions

As the creator of the Wiki space you are automatically also the Space Administrator or Admin, and can set restrictions for viewing the page, but please note the following rules:

Warning
title

...

  • älä poista alueen hallinnointioikeuksia (Space Admin) itseltäsi!
  • älä anna anonyymeille käyttäjille muita oikeuksia kuin luku- ja kommentointioikeus (View, Comment)
  • seuraa säännöllisesti mitä alueellasi tapahtuu, rajoita käyttöoikeuksia tarvittaessa ja ota vakavissa ongelmatilanteissa yhteys ylläpitoon

Pääset muokkaamaan alueesi oikeuksia Browse space > Space admin > Permissions (kts. kuva alla - klikkaa suuremmaksi).

Image Removed

3.1 Ryhmien hallinta (Groups)

Alueet ovat luotaessa avoimia, eli kaikki kirjautuneet käyttäjät (confluence-users) voivat lukea ja kommentoida niitä. Mikäli haluat rajata oikeudet vain TKK:n tunnuksia käyttäville, lisää alueellesi ryhmä tkk_users, tkk_staff ja/tai tkk_student. Voit halutessasi myös poistaa alueeltasi ryhmiä poistamalla niiltä kaikki oikeudet.

...

Important rules
  • Do not remove your permission to administer the space! (i.e., Space Admin rights)
  • Assign anonymous users only the permission to view and comment on the content.
  • Monitor your space regularly. When needed, restrict permissions, and in case of serious problems, contact the servicedesk
  • Granting Pages add - rights to confluence-users (the default setting) means that every user in Aalto Wiki, also users outside Aalto, can edit and add pages in your wiki space

Managing wiki space permissions :

Managing wiki page permissions :

To adjust space permissions in Global theme, click Space Tools > Permissions

Image Added

 

To adjust space permissions in Documentation theme, click Browse Space > Space Admin > Permissions (See picture below - click to enlarge picture).

Image Added

 

3.1 Managing Groups

By default, all spaces are open, which means that all registered users ('confluence users') can read and comment on them. If you want access to be restricted only to those with Aalto username, add the group aalto_users, aalto_staff and/or aalto_student. You can remove groups from your space by removing all their permissions.

  1. To assign permissions go to: Browse space > Space admin > Permissions.

...

  1. Choose 'Edit Permissions

...

  1. ' under the heading 'Groups'.
  2. If you want to add a group, write the name of the group under the heading 'Groups' into the text box 'Grant permission to' and select 'Add'.
  3. Add or remove permissions.
  4. Save changes by clicking 'Save All'.
  5. Check that everything was done correctly.
Info

If you want to delete the entire group, uncheck all the boxes and save!

Tip
title

...

Useful links:

...

...

...

...

Tip
titleHAKA

...

tip

...

The user group haka_users

...

consists of reliably identified users whose home organisation is a Finnish university, polytechnic or research institute.

3.2

...

Usein on tarpeen asettaa oikeudet joka käyttäjälle erikseen. Varsinkin jos haluat pitää alueesi suljettuna tai haluat antaa tietyille käyttäjille enemmän oikeuksia kuin koko ryhmälle.

Poimi käyttäjät seuraavasti:

...

Custom Space User Management

3.3 Individual Users

It is often necessary to assign permissions separately for each user in a group, especially if you want access to the wiki space to be restricted, or want to grant more rights  to certain users belonging to a group than to the entire group.

Select the users as follows:

  1. Go to permissions: Browse space > Space admin > Permissions.

...

  1. Select 'Edit Permissions

...

  1. ' under the heading 'Individual users

...

Info

Jos haluat poistaa käyttäjän kokonaan alueeltasi, valitse kaikki ruksit pois ja päivitä!

Tip
titleLinkkivinkki

http://confluence.atlassian.com/display/CONF20/Space+Permissions+Overview
http://confluence.atlassian.com/display/CONF20/Administering+Spaces

3.3 Kirjautumattomat käyttäjät (Anonymous users)

Alueet ovat luotaessa julkisia, eli kirjautumattomat käyttäjät (Anonymous Access) voivat lukea sivuja. Voit halutessasi rajata alueen näkyvyyden vain jäseninä oleville yksilöille tai ryhmille poistamalla ko. oikeudet:

...

  1. '.
  2. Write the usernames one by one or separated by commas to the text box 'Users to add'.
  3. You can also use a search tool: click the magnifying glass icon to find a username either by typing part of the name or the user's email address.
  4. Select 'Add'.
  5. If you cannot find the persons you are looking for, they probably are not registered users of the wiki service yet.
  6. Add or remove the necessary permissions.
  7. Save all the changes by clicking 'Save All'.
  8. Make sure that everything was done correctly.

    Info

    If you want to permanently remove a user from the wiki space, uncheck all boxes and reload the page.

3.4 Anonymous Users

All wiki spaces are by default 'open' in that they allow access to anonymous users. However, you can restrict the permission to view the space only to individual members and member groups by removing the permission to anonymous access:

  1. Go to permissions: Browse space > Space admin > Permissions.

...

  1. Select 'Edit Permissions

...

  1. ' under the heading 'Anonymous Access

...

Warning

Älä lisää kirjautumattomille käyttäjille muita oikeuksia kuin luku ja kommentointi!

4. Kutsu käyttäjät mukaan

Erillistä kutsusovellusta ei ole, vaan voit kutsua esim. tämän kaltaisella viestillä:

Tervetuloa kurssin/projektin 'X' wikialueelle!
Olen perustanut TKK:n wikipalveluun oman wikialueen nimeltä 'X'. Löydät sen osoitteesta http://wiki.tkk.fi/display/X/

TKK:n käyttäjät kirjautuvat sisään pääkäyttöluvan mukaisella tunnuksella ja salasanalla. Mikäli kotiorganisaatiosi kuuluu HAKA-luottamusverkostoon voi käyttää HAKA-kirjautumista. Vierailijat voivat itse luoda oman sähköpostiosoitteen mukaisen tunnuksen osoitteessa http://wiki.tkk.fi/signup.action"

Katso tarkempia ohjeita käyttäjän pikaoppaasta http://wiki.tkk.fi/display/support/Pikaopas

Tervetuloa mukaan!

5. Varmuuskopiointi ja arkistointi

Info

On alueen ylläpitäjän vastuulla, että wikialueesta tehdään säännöllisesti varmuuskopioita.

Varmuuskopioita tehdään seuraavasti:

...

Info

Mikäli haluat palauttaa varmuuskopioidun alueen, ota yhteys wikipalvelun ylläpitoon webmaster 'at' tkk 'dot' fi

6. Poistaminen

Warning

Wikialue kannattaa ehdottomasti arkistoida ennen sen poistamista sillä poistaminen on peruuttamaton toimenpide!

Kannattaa myös miettiä tarkkaan onko poistaminen tarpeen ja informoida siitä hyvissä ajoin kaikkia työskentelyyn osallistuneita (myös vierailijoita).

...

  1. '.
  2. To deny the permission to view, uncheck 'View'.
  3. To deny the permission to comment, uncheck 'Comments - Create'
  4. Save all the changes by clicking 'Save All'.
  5. Make sure that everything was done correctly.
Warning

Anonymous users must only be granted permission to read and comment!

5. Backup Files and Archiving

Info

The space admin is responsible for making backups files of the wiki space on a regular basis.

 

To make a backup file:

  1. Log into your space.
  2. Select 'Browse Space' (Documentation theme & Aalto Intranet theme) or 'Space tools' (Global theme)
  3. Select 'Advanced' (Documentation theme & Aalto Intranet theme) or 'Content Tools' (Global theme)
  4. Select 'Export Space' or 'Export'.
  5. Select 'Export Format'
    1. XML export -> for other Confluence instances
    2. HTML -> as a static web site
    3. PDF -> every page as a pdf file.
  6. Check the boxes beside all the pages (plus comments and attachments).
  7. Select 'Export'.
  8. Save the file for archiving.

    Info

    If you want to restore a space of which a backup file has been made, please contact the wiki service administrators.

6. Removing the Wiki Space

Warning

Space admins are strongly advised to archive the space before removing it, because the removal is irreversible!

 

Consider carefully whether removing the space is necessary, and inform all users of the removal well in advance (including visitors).

If you are certain you want to remove the space, go to Space Admin: Browse Space > Space Admin > Remove Space.

Panel

Table of Contents
minLevel2
stylenone

Panel