Help:Creating Troubleshooting Content

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Categories)
(Configuration Output)
Line 22: Line 22:
Examples should use preformatted text. Put your example in the following format:
Examples should use preformatted text. Put your example in the following format:
-
  <nowiki><pre>Your configuration example text</pre></nowiki>
+
  <nowiki><pre>Your configuration output text</pre></nowiki>
==Categories==
==Categories==

Revision as of 01:15, 26 August 2011

Configuration examples should have consistent content. The following guidelines can help you create a configuration example.

Contents

Creating your Troubleshooting Page

Type the name of your troubleshooting topic into the search box. Use the following syntax:

<product name> Troubleshooting

For example, "Cisco Unity Express Troubleshooting"

If the page does not exist, you will be prompted to create a page. Copy the source code at Template:Simple_Troubleshooting_Template to your new page to develop your content.

Note Note: This template contains details that might not be applicable to your troubleshooting information. Please edit at your discretion.

Topology

The topology that you upload should be a JPEG or GIF file. Many tools provide icons for topologies. Cisco also provides icons at the Marketing Library.

Configuration Output

Caution Caution: Make sure that you scrub the IP addresses, domain names, and any other sensitive information. Examples of clean content are shown at DocWiki:No Proprietary Information.

Examples should use preformatted text. Put your example in the following format:

<pre>Your configuration output text</pre>

Categories

Categories for Troubleshooting differ slightly from a regular article. For the most part, the paths for the categories are the same as for Cisco Products (see DocWiki:Categories). An additional layer of categories is placed right above the article so that troubleshooting information can be grouped together.

Categories-tshoot.jpg

Personal tools