Middlebury

Difference between revisions of "Wiki Editing Protocol"

(Internal vs. public information: Adding link to the new 'hi' template.)
(Updating page content and purpose to reflect presence of HI)
Line 3: Line 3:
  
 
==Purpose & Content==
 
==Purpose & Content==
There are several reasons we might want to have a wiki.
+
We can use a wiki to improve our organization and communication in many ways.
* A place to keep track of common computer problems and how to approach them.
+
# A place to keep track of common computer problems and how to approach them.
* A place to organize our growing collection of how-to articles, to make them more accessible to the public than our current knowledgebase system does.
+
# A place to organize our growing collection of how-to articles, to make them more accessible to the public than our current knowledgebase system does.
* A place to post news on changes to the Helpdesk system, to keep us (and maybe users) updated on policy / protocol / structural decisions, and to post reminders and tips so that we will all be able to see them. A flexible "Helpdesk newsletter" of sorts.
+
# A place to codify the Helpdesk policy re: language schools, licensing, and the help we offer.
* An internal reference which we Helpdesk staff could use to keep track of our duties and how to perform them effectively.
+
# A place to post news on changes to the Helpdesk system, to keep us (and maybe users) updated on policy / protocol / structural decisions, and to post reminders and tips so that we will all be able to see them. A flexible "Helpdesk newsletter" of sorts.
* A "common room" for discussing frequent problems, structural problems, and aspects of our technology/ITS system which we could improve.
+
# An internal reference which we Helpdesk staff could use to keep track of our duties and how to perform them effectively.
 +
# A "common room" for discussing frequent problems, structural problems, and aspects of our technology/ITS system which we could improve.
 +
# A central place to keep resources and links which we all want to have available. (Think Petar's and Amy's links! And I know there are more cool pages and links like those out there... they should be here, available to everyone.)
  
Due to security concerns when discussions may touch on (revolve around?) sensitive topics, in my opinion the last two points are not suitable content for a ''public'' wiki. However it is possible for us to create a second, closed-access wiki which we could use for internal purposes. I would strongly support this option of creating a private wiki, provided that other staff see its potential benefit to us.
+
==Public wiki vs. Internal wiki==
--[[User:Chunt|Hunt, Christopher]] 14:37, 20 July 2008 (EDT)
+
A glance at the uses listed above make clear the desirability of a restricted-access wiki. While the first three uses are probably fine topics to have on a public wiki, uses 4 and after are a bit more questionable. Some of the content of those topics might be perfectly fine for public eyes; other information is in a "grey area" where, often for security reasons, a lot of information should probably be restricted just to those people who are involved in the Helpdesk workings. Still other information, such as passwords and registration keys, should never go on either wiki at all. (See below).
  
====Internal vs. public information====
+
Our current structure actually involves two wikis: [[Helpdesk|this public wiki ("LIS")]], and the {{hi|Main Page|Helpdesk Internal wiki ("HI")}}. The former can be viewed by anyone in the world, and can be edited by anyone with a Middlebury network account; the latter can only be viewed and accessed by Helpdesk staff and consultants.
I won't go deeply into my concerns about the availability of information that should not be public - but I do have some. I believe that centering the Helpdesk's reference knowledgebase around a public wiki would force us to make a very clear distinction between what information is OK for public access and what information should be kept in our secure servers.
 
* No passwords or private links should ever go here.
 
* No contact info of individuals, whether part of the Helpdesk or not. I guess if you want to post your contact info on your wiki profile page, that's up to you.
 
* We probably should not put up information that exactly describes the internal workings of the Helpdesk such that this could be studied and manipulated (such as information on account creation procedure).
 
* Where necessary, we can ''reference and link to'' documents stored on our secure servers, such that confidential information is available to us.
 
--[[User:Chunt|Hunt, Christopher]] 14:37, 20 July 2008 (EDT)
 
* Use the [[Template:hi|'hi' template]] to link to pages in the {{hi|Main_Page|Helpdesk Internals wiki}}
 
  
====Grouping together hidden resources====
+
--Topher
In the process of supporting my above arguments I've spent a little time at Amy and Petar's respective community.middlebury.edu sites. I'm finding all sorts of really valuable information in there - information which ''I would never have found otherwise'' [http://community.middlebury.edu/~pmitrevs/software.html]. I'm sure I've only touched the tip of the iceberg in this respect. Given its flexible and easy-to-edit nature, I think this wiki would be a perfect chance for valuable information like that hidden in our community sites to be integrated into other knowledge sources so that we will be more likely to stumble across them.
 
  
--[[User:Chunt|Hunt, Christopher]] 17:03, 9 July 2008 (EDT)
+
====Linking between our public and private wikis====
 +
Thanks to some super-special setup from Joe and Adam, we can easily create links between our public and private wikis. This will let us mesh our wikis together almost as though they were one wiki - but any information that needs to be private will be kept private. To make a link to an article on the Internal Wiki, the format needed will look something like this:
 +
 
 +
<code><nowiki>{{hi|ArticleName|text you want to display}}</nowiki></code>
 +
 
 +
Similarly, to make a link from the HI wiki to this wiki ("LIS"), the code will look like this:
 +
 
 +
<code><nowiki>{{lis|ArticleName|text you want to display}}</nowiki></code>
 +
 
 +
See also the [[Template:hi|HI linking help]] page.
 +
 
 +
====Public content vs. private content====
 +
 
 +
For a rundown of what information should be kept private, see the {{hi|Main Page|HI Main Page}}.
 +
 
 +
The basic rule is: '''Any information that could help an intruder to attack or compromise the Middlebury network, should never go on the public wiki.''' However, some information (passwords, serial keys) shouldn't go on either wiki at all.
 +
 
 +
When you want to add some information that ''might'' be a security concern and you're not sure whether to put it on the public or the private wiki, '''choose the private wiki'''.
 +
 
 +
If you think you have a better way to state this rule, please talk to Petar, Nate, or someone before changing it. We want your suggestions! But we also need to make sure that this guideline is very clear.
 +
 
 +
--Topher
  
 
==Rules of thumb==
 
==Rules of thumb==
* '''Sign your contributions!''' I'd suggest that when you contribute a major section to the wiki, you sign your name next to it. (Use the Signature button on the edit toolbar.) We can see info on all edits anyway in the History tab, but signing makes it more of a community effort.
+
* '''Sign your contributions!''' I'd suggest that when you contribute a major section to the wiki, you sign your name next to it. We can see info on all edits anyway in the History tab, but signing makes it more of a community effort. --Topher
* If you make a new page, '''make sure there is a link''' from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily. Eventually, if this wiki gets big, we'll need a table of contents to index everything.
+
* If you make a new page, '''make sure there is a link''' from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily.
 +
* '''Adjust the wiki structure as necessary.''' As the wiki grows and pages are added, the table of contents might need adjusting or regrouping. It's up to you to change the wiki structure as needed to make it easy to access what we need to access. (Just make sure you don't lose links to articles along the way! We don't want any orphaned articles that don't have any links to them.)
 
* '''When you're not sure whether to contribute, contribute anyway'''. Err on the side of adding too much. It's easy to take out content or move it to a more relevant section. It's harder to create an environment where everyone feels comfortable jumping in to help. So if you ''might'' have something good to say, say it. Same goes if something isn't worded clearly and you can think of a better way to say it.
 
* '''When you're not sure whether to contribute, contribute anyway'''. Err on the side of adding too much. It's easy to take out content or move it to a more relevant section. It's harder to create an environment where everyone feels comfortable jumping in to help. So if you ''might'' have something good to say, say it. Same goes if something isn't worded clearly and you can think of a better way to say it.
* All helpdesk-specific pages should be added to the '''Helpdesk category'''. Do this by adding the '''<nowiki>[[Category:Helpdesk]]</nowiki>''' text to the top of the page.
+
* The exception to this last rule is with '''sensitive information''': if you want to contribute something and you don't know whether it should be on the public or internal wiki, '''stay on the safe side''' and put it in the internal wiki.
* '''"Minor edit"''' is for small corrections that other users don't need to know about. So if a page is on my watch-list (meaning I am notified of changes to that page), I won't be notified if you make the change as a "minor edit".
+
* When you create a new page, add it to the '''Helpdesk category'''. Do this by adding the '''<nowiki>[[Category:Helpdesk]]</nowiki>''' text to the top of the page.
--[[User:Chunt|Hunt, Christopher]] 18:18, 9 July 2008 (EDT)
+
* Please mark a change as a '''minor edit''' only if you're correcting spelling, correcting a link, correcting formatting, or other small changes like that.
* If your are just adding a placeholder page that needs to be fleshed-out, add the '''[[Template:Stub|<nowiki>{{stub}}</nowiki>]]''' text to the top of the page so that others can easily find it. --[[User:Afranco|Franco, Adam]] 11:15, 10 July 2008 (EDT)
+
* If your are just adding a placeholder page that needs to be fleshed-out, add the '''[[Template:Stub|<nowiki>{{stub}}</nowiki>]]''' text to the top of the page so that others can easily find it. --[[User:Afranco|Franco, Adam]]
  
 
==How to edit==
 
==How to edit==
To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the '''Edit''' tab (or Edit link to the right of the appropriate section, for long pages) and start editing.  
+
* To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the '''Edit''' tab (or Edit link to the right of the appropriate section, for long pages) and start editing.  
* Look for how-to edit links on the edit page that will explain useful formatting marks, for creating features such as bold / italic text, links, and section headers. Go to the Edit tab of any existing page to get a sense for how the formatting syntax works.
+
* Wiki has its own formatting language that takes some getting used to. Check out the [[Help:Editing|Editing Help]] page, or just use the Edit tab on this page to study how to make text into headers, '''bold''', ''italics'', [[Helpdesk|linked]], and so forth.
 +
 
 +
--Topher

Revision as of 19:48, 16 August 2008

Information on the purpose of this wiki, what to put in it, how to organize it, how to edit it.

Purpose & Content

We can use a wiki to improve our organization and communication in many ways.

  1. A place to keep track of common computer problems and how to approach them.
  2. A place to organize our growing collection of how-to articles, to make them more accessible to the public than our current knowledgebase system does.
  3. A place to codify the Helpdesk policy re: language schools, licensing, and the help we offer.
  4. A place to post news on changes to the Helpdesk system, to keep us (and maybe users) updated on policy / protocol / structural decisions, and to post reminders and tips so that we will all be able to see them. A flexible "Helpdesk newsletter" of sorts.
  5. An internal reference which we Helpdesk staff could use to keep track of our duties and how to perform them effectively.
  6. A "common room" for discussing frequent problems, structural problems, and aspects of our technology/ITS system which we could improve.
  7. A central place to keep resources and links which we all want to have available. (Think Petar's and Amy's links! And I know there are more cool pages and links like those out there... they should be here, available to everyone.)

Public wiki vs. Internal wiki

A glance at the uses listed above make clear the desirability of a restricted-access wiki. While the first three uses are probably fine topics to have on a public wiki, uses 4 and after are a bit more questionable. Some of the content of those topics might be perfectly fine for public eyes; other information is in a "grey area" where, often for security reasons, a lot of information should probably be restricted just to those people who are involved in the Helpdesk workings. Still other information, such as passwords and registration keys, should never go on either wiki at all. (See below).

Our current structure actually involves two wikis: this public wiki ("LIS"), and the Page Helpdesk Internal wiki ("HI") . The former can be viewed by anyone in the world, and can be edited by anyone with a Middlebury network account; the latter can only be viewed and accessed by Helpdesk staff and consultants.

--Topher

Linking between our public and private wikis

Thanks to some super-special setup from Joe and Adam, we can easily create links between our public and private wikis. This will let us mesh our wikis together almost as though they were one wiki - but any information that needs to be private will be kept private. To make a link to an article on the Internal Wiki, the format needed will look something like this:

{{hi|ArticleName|text you want to display}}

Similarly, to make a link from the HI wiki to this wiki ("LIS"), the code will look like this:

{{lis|ArticleName|text you want to display}}

See also the HI linking help page.

Public content vs. private content

For a rundown of what information should be kept private, see the Page HI Main Page .

The basic rule is: Any information that could help an intruder to attack or compromise the Middlebury network, should never go on the public wiki. However, some information (passwords, serial keys) shouldn't go on either wiki at all.

When you want to add some information that might be a security concern and you're not sure whether to put it on the public or the private wiki, choose the private wiki.

If you think you have a better way to state this rule, please talk to Petar, Nate, or someone before changing it. We want your suggestions! But we also need to make sure that this guideline is very clear.

--Topher

Rules of thumb

  • Sign your contributions! I'd suggest that when you contribute a major section to the wiki, you sign your name next to it. We can see info on all edits anyway in the History tab, but signing makes it more of a community effort. --Topher
  • If you make a new page, make sure there is a link from the main page to it. That way we don't "lose" pages, and everyone can reach the new page easily.
  • Adjust the wiki structure as necessary. As the wiki grows and pages are added, the table of contents might need adjusting or regrouping. It's up to you to change the wiki structure as needed to make it easy to access what we need to access. (Just make sure you don't lose links to articles along the way! We don't want any orphaned articles that don't have any links to them.)
  • When you're not sure whether to contribute, contribute anyway. Err on the side of adding too much. It's easy to take out content or move it to a more relevant section. It's harder to create an environment where everyone feels comfortable jumping in to help. So if you might have something good to say, say it. Same goes if something isn't worded clearly and you can think of a better way to say it.
  • The exception to this last rule is with sensitive information: if you want to contribute something and you don't know whether it should be on the public or internal wiki, stay on the safe side and put it in the internal wiki.
  • When you create a new page, add it to the Helpdesk category. Do this by adding the [[Category:Helpdesk]] text to the top of the page.
  • Please mark a change as a minor edit only if you're correcting spelling, correcting a link, correcting formatting, or other small changes like that.
  • If your are just adding a placeholder page that needs to be fleshed-out, add the {{stub}} text to the top of the page so that others can easily find it. --Franco, Adam

How to edit

  • To edit you'll need to log in using your Middlebury network credentials. Then, on any page you want to change, click the Edit tab (or Edit link to the right of the appropriate section, for long pages) and start editing.
  • Wiki has its own formatting language that takes some getting used to. Check out the Editing Help page, or just use the Edit tab on this page to study how to make text into headers, bold, italics, linked, and so forth.

--Topher