You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

This article provides simple step by step instructions on creating a knowledge base article for the Appalachian Technology Knowledge Base using approved templates.


At this time permission must be granted to create an article for the Knowledge base. Request permission by emailing ransompa@appstate.edu (Paula Ransom)


  1. Navigate to the ATKB Space by clicking on Spaces at the top of the page. If you do not see Appalachian Technology Knowledge Base listed, click on Space directory to see a list of all Spaces available.

  2. Click on the "Create from template" button


  3. Choose the template you would like to use (How-to or Troubleshooting)
  4. Click Next

  5. Enter the title of the article into the Name text box
    1. How-to Article titles should be the part of the sentence following "How to". 
      Example: How to create a knowledge base article for ATKB = Create a Knowledge Base Article for ATKB
    2. Troubleshooting Article titles should be a simple description of the problem.
      Example: Missing Classes in AsULEARN
  6. Enter label(s) for article in the Label text box
    Article should be labeled for the service or software it falls under. Labels are lower case and one word only. If two words are needed use a dash in between the words (ex: asulearn, digital-measures, google-group). You must hit enter after typing in each label for it be added. Click the x next to the label if you need to remove it. These labels are used to organize articles only (list Related Articles together and in the Page Tree). Searches in Confluence and Jira Service Desk include the title and body of articles so extensive labeling is unnecessary.
  7. Click Create (The title and labels can be edited after creation)

  8. Fill out Template
    1. The cell on the left is the body of the article. 
      Click on Instructional text to replace with the text of the article. Instructional text will not show up on the published article so can be ignored. Elements are movable and can be deleted. Use the format toolbar at the top of the page to add elements and format body of article. Click Preview at the bottom of the page to see what will be published. From Preview mode you will click Edit to get back to Edit Mode. Please leave the hidden Page Properties box at the bottom of your article. This is used for reporting purposes and will not show up anywhere but edit mode.


    2. The cell on the right is for Links and Pertinent information. Please do not alter this section. You can add to it, just do not remove or move the current elements.
      • HOME is a link to the ATKB Dashboad - No editing needed
      • Related Articles is the Content by Label Macro that will list articles that have the same label(s) as your article - Editing is not needed unless you alter your labels after creation.
      • Next is the location to add links to additional information - Use link button at top of page to add - No Editing is needed if you do not wish to add any links
      • The Link to the customer service portal is not currently configured but once ATSD has been moved to production this will be a link to the customer portal. - No editing needed.



  9. Click Save



HOME


There is no content with the specified labels



Confluence Documentation on Article/Page Creation



  • No labels