Changes

Wiki Editing CheatSheet

157 bytes added, 18 January
Links to External Pages
=Overview=
SmartSimple’s Wiki is a repository of knowledge used targeted at system Administrators intended to help make learning and configuring Platform3 easy to do. The target audience is System Administratorseasier. This page will provide guidance for anyone who is contributing to the wiki. By establishing Following established standards to follow that will improve the user experience of this Wiki. All changes to the Wiki should be reviewed by another SmartSimple employee. All new articles should follow the template found in google drive > shared drives > Wiki project or look at the below.For statistics you can look at the dashboards and https://wiki.smartsimple.com/wiki/Special:SpecialPages
==Wiki article structure==
All wiki articles need to should follow this format:
===Overview===
===Settings Explained===
List all the settings used by this page/feature, what the setting does and if not self evident why you would use it. This should be presented in a table format. Example: Setting: Is Default Login Page, Description: By default, when a user goes to your system's URL, example https://smart.smartsimple.com they will be directed to the English US language login page. If you want users to go to a different language login page by default, toggle In time this setting on for the login page with your desired language. Note: only one login page can be set as the default. ===See Also===This section is optional. If there are other related articles you think a user should be made aware of or that you have mentioned in this article you may wish to add links to these articles here. Be mindful that any static links you add here will need to be maintained. If a page name changes someone will need to go back and fix every link added to every page replaced by an in the See Also. For these reasons try to categorize your articles instead of using the see also as it is easy to go to a category and see all related articles and those links update automaticallysystem help.
===Category===
Make sure every article has a category. This way it is easy to find all related pages. Ideally all articles should be in one of the categories found on the home page https://wiki.smartsimple.com/wiki/Main_Page. This way anyone entering the wiki for the first time can find all the good articles. If an article falls into more than one category that is ok.
===Other considerations===
* Add [[Wiki_Editing_CheatSheet#Hyperlinks|hyperlinks]] to other pages where SmartSimple's terminology is used.
* Use US English for spelling.
* Use [https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions Microsoft conventions] for writing instructions (When you refer to a button, check box, or other option, use bold formatting for the name)
<pre>[[Branding|Different text]]</pre>
 
Link to a heading on the same page
 
[[#Heading Levels|Heading Levels]]
 
<pre>[[#Heading Levels|Heading Levels]]</pre>
===Links to External Pages===
<pre>[https://www.smartsimple.com smartsimple.com]</pre>
 
Note:
* You must specify text for the link or it will show up as a number.
* All external links open in a new window.
 
===Email Links===
 
[mailto:sales@smartsimple.com sales@smartsimple.com]
 
<pre>[mailto:sales@smartsimple.com sales@smartsimple.com]</pre>
==Image Files==
To display an image
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]]</pre>
Images are uploaded at a resolution of 1280 pixels but displayed at 800px.
Image with internal link
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|800px|The four disability classifications|link=Accessibility]]</pre>
Image with external link
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=https://www.smartsimple.com/agreements.html|800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|800px|The alt=four disability classificationsimages of disabilities|link=https://www.smartsimple.com/agreements.html|800px|The four disability classifications]]</pre>
You can upload a new version of any file by typing '''File:''' then your desired file name into the search.
* Add '''smartstaff''' group.
* Click '''OK'''.
 
==Deleting Articles==
# Before you delete an article use the tool in the left navigation called '''what links here'''.
# Once you have removed the links go to the '''More''' menu top right and select delete.
# Make sure you delete all pages no longer required.
# Delete the category the pages are grouped in if that is no longer needed.
# Do a Search top right to make sure the content is not found on other pages.
 
==Finding Broken Links==
When articles are deprecated or deleted, or the name is changed, it may result in broken links. You can see a list of broken links by going to https://wiki.smartsimple.com/index.php?title=Special:BrokenRedirects
 
[[Category:SmartSimple]]
 
[[aitranscriptgpttest]]
Smartstaff, administrator
3,320
edits