Moving Documentation to the ITKB

What should go on the ITKB?

Are you thinking about moving documentation to the ITKB? Here are some guidelines to help you determine what belongs here and what doesn't:

• Is the documentation directed toward technicians or clients?
  • The ITKB is intended to be written for a technician audience. Documentation that answers questions for end users (e.g. set-up instructions, FAQs, etc.) is still perfectly appropriate because it's also useful for technicians, but clients should not be purposely directed to the ITKB as a source of information.
• Does the documentation need to be private?
  • Currently, the ITKB is viewable by the world. This means that anything that absolutely must be kept private (e.g. admin passwords) is not currently appropriate for this wiki. Openness and information sharing is a large part of the ITKB's value, but if necessary and appropriate, it's possible to restrict pages/sections to Tufts technicians only (talk to Molly).
• Is this information already on the ITKB?
  • We'd like to avoid duplicate pages, so please take a look and do a search before adding new content to the ITKB. If the information or similar information exists, consider whether it will make sense to remove an outdated page, update an outdated page, or edit the page to merge different bits of related information onto one page.
• Will this documentation be useful or interesting to other people?
  • It doesn't matter! If you're not sure if anyone will ever read or use the documentation, share it anyway (provided it meets the requirements above). You never know when your process will help another group refine theirs, or your information about a new project will lead to collaboration with another group, etc.

How to Transfer Documentation

Planning

Before you begin the process of transferring documentation, consider the following to help determine how best to move the content:

• Is this documentation related to an existing "section" of the ITKB? (See the left sidebar; e.g. Exchange, Account Administration, etc.). Should this documentation have its own section? Where in the ITKB does this content belong?
• Does the documentation require its own page, or can it be edited into an existing related page? Does it require multiple pages? How should it be organized?

From a Spark Wiki

Transferring documentation from another Spark wiki (Tufts' main Confluence instance, URL contains wikis.uit.tufts.edu) is easy. To transfer a page, a group of pages, or even an entire wiki:

1. You need to be a space admin on both wikis. Contact Molly so I can make you a temporary ITKB space admin for this task.
2. On the most top-level page that you'd like to move, go to Tools > Move.
   • It's important to note that using this method will completely move the pages, not just copy them, and it will move any and all child-pages underneath the one you are moving. If you use this method on the root page of a wiki, it will move the entire wiki space into the ITKB and completely eliminate the other wiki.
3. Change the "New parent space" to ITKB
4. Select the "New parent page" - this will vary based on where within the ITKB you've decided this documentation will live (a new section, an existing section, etc.). To make it an entirely new section within the ITKB, select "Home" as the new Parent page.
5. Click OK.

From Another Wiki

Unfortunately there is no built-in method to move documentation from one Confluence instance to another (so, from a non-Spark wiki to the ITKB). To accomplish this, the best method is most likely to manually create new pages where you want them in the ITKB, and then copy and paste the Wiki Markup from the previous location.