Help:Creating Configuration Examples - Revision history

Pzimmerm: Added category

2009-10-30T19:24:03Z

Added category

← Older revision		Revision as of 19:24, 30 October 2009
Line 29:		Line 29:

	[[Image:Categories-configex.jpg]]		[[Image:Categories-configex.jpg]]
		+
		+	[[Category:Docwiki Help]]

Pzimmerm: Updated to remove robust example

2008-12-04T18:51:04Z

Updated to remove robust example

← Older revision		Revision as of 18:51, 4 December 2008
Line 12:		Line 12:

	{{note\|This template contains details that might not be applicable to your example. Please edit at your discretion.}}		{{note\|This template contains details that might not be applicable to your example. Please edit at your discretion.}}
-
-	~~==Filling Out the Configuration Example Infobox for the Robust Configuration Example==~~
-
-	~~After you have copied the template into your new page, fill out the Infobox information. Replace the comment text (<nowiki><!--Comment text--></nowiki>) with the required information.~~
-
-	~~<pre>{{Infobox Configuration Example~~
-	~~\|title = <!--Enter the name of your example: (product_name) (feature/description) Configuration Example -->~~
-	~~\|image = [[Image:sample_topology.jpg]] <!--Upload an image of your topology-->~~
-	~~\|caption = Topology~~
-	~~\|device1 = <!--Decsribe the first device: (router)(location)-->~~
-	~~\|dev1_sw = <!--Enter the name of the software: (OS, like Cisco IOS) (release number)-->~~
-	~~\|dev1_feat = <!--List the featured used in this example-->~~
-	~~\|dev1_ip = <!--Enter the sanitized example address, no real addresses-->~~
-	~~\|dev1_inf = <!--List any additional information needed for this example-->~~
-	~~\|device2 = <!--Decsribe the second device: (router)(location)-->~~
-	~~(add up to 8 devices as above)~~
-	.
-	.
-	.
-	~~\|netinfo = <!--Describe any additional information about the network for this example-->~~
-	~~}} </pre>~~

	==Topology==		==Topology==

Pzimmerm: /* Creating your Configuration Example Page */

2008-12-04T18:50:25Z

Creating your Configuration Example Page

← Older revision		Revision as of 18:50, 4 December 2008
Line 9:		Line 9:
	For example, "Cisco Unity Express Networking with Direct IP Addressing Configuration Example"		For example, "Cisco Unity Express Networking with Direct IP Addressing Configuration Example"

-	* If the example does not exist, you will be prompted to create a page. Copy the source code at [[Template:Configuration Example]] to your new page to develop your content.	+	If the example does not exist, you will be prompted to create a page. Copy the source code at [[Template:Configuration Example]] to your new page to develop your content.
-		+
-	* If your configuration example is complex and has several devices, you might consider using the [[Template:Robust Configuration Example]]	+

	{{note\|This template contains details that might not be applicable to your example. Please edit at your discretion.}}		{{note\|This template contains details that might not be applicable to your example. Please edit at your discretion.}}

Pzimmerm: Initial posting

2008-12-04T18:42:09Z

Initial posting

New page

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

==Creating your Configuration Example Page==

Type the name of your configuration example into the '''search''' box. Use the following syntax:

'''<product name> <feature/description> Configuration Example'''

For example, "Cisco Unity Express Networking with Direct IP Addressing Configuration Example"

* If the example does not exist, you will be prompted to create a page. Copy the source code at [[Template:Configuration Example]] to your new page to develop your content.

* If your configuration example is complex and has several devices, you might consider using the [[Template:Robust Configuration Example]]

{{note|This template contains details that might not be applicable to your example. Please edit at your discretion.}}

==Filling Out the Configuration Example Infobox for the Robust Configuration Example==

After you have copied the template into your new page, fill out the Infobox information. Replace the comment text (<nowiki></nowiki>) with the required information.

<pre>{{Infobox Configuration Example
|title = 
|image = [[Image:sample_topology.jpg]] 
|caption = Topology
|device1 = 
|dev1_sw = 
|dev1_feat = 
|dev1_ip = 
|dev1_inf = 
|device2 = 
(add up to 8 devices as above)
.
.
.
|netinfo = 
}} </pre>

==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 [http://resources.cisco.com/app/tree.taf?asset_id=64914&public_view=true| Marketing Library].

==Configuration Output==
{{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:

<nowiki><pre>Your configuration example text</pre></nowiki>

==Categories==

Categories for Configuration Examples 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 Configuration Examples can be grouped together. See the following flow:

[[Image:Categories-configex.jpg]]