¶ Wiki usage SOP
¶ Page creation guidelines
- Pages should always be created using in all lowercase
- Pages should not contain spaces. Use dashes instead
- At NO TIME should passwords be listed in any wiki entry.
- Pictures and video are called “assets” in this wiki. When uploading assets, make sure to pay attention to the namespace/folder where you are uploading to as permissions for uploading assets is also based on the namespace permissions below. Navigate to the appropriate folder based on the namespace you are creating/editing pages in. Create additional subfolders as needed within the namespace.
- For example, if you are creating your personal “About Us” page and adding a picture, first navigate into the "About Us" folder (see picture below). You can then create a folder with your name and then upload the picture into that folder.
- When uploading images/media to the wiki, choose the folder in the appropriate namespace where the page is. For example, if you are uploading a picture of your dog for your “aboutus” page, save the file somewhere within the “aboutus” folder when uploading assets.
- Feel free to create folders as needed. In the dog picture example, I created a folder called “mikecoats” under the “aboutus” folder to save the pictures for my page.
¶ Primary folder/namespaces
There are several primary folders/namespaces. Each major discipline will have their own namespace where sub-pages can be created. Here are the main ones currently create:
| Namespace | This namespace area is for…. |
|---|---|
| /aboutus | Creating a personal page about you so we can get to know each other better |
| /desktop-apps | Desktop-based apps that technicians support |
| /development | MiTech Development team to document their apps (MiRooms, etc.) |
| /districts | District-specific documentation |
| /hardware | Endpoint hardware, such as computers, printers, etc. |
| /hosted-apps | Server-based applications and apps supported by our App Support Team |
| /information-security | Info-sec SOP's and documentation |
| /microsoft-team | Microsoft Team back-end tech such as SCCM, Intune, AD, Azure AD, etc. |
| /mitech | MiTech department-wide documentation and SOP's |
| /mitech-leadership | MiTech Leadership team |
| /network-team | Network Team documentation and SOPs |
| /operations | Maintenance Team documentation |
| /public | Public-facing content, such as QuickStart guides, FAQs, Tips & Tricks, etc. |
| /server-team | Server Team documentation and SOP's |
| /vendors | Vendor contact information |
¶ How to create pages
¶ New page creation tips - There are two main ways to create a new page
- Before creating a new page, try editing a “parent” page and creating a link to the page you want to create. Save it and then click on the link. It will take you to a page that doesn't exist. You can then use the “Browse to a page doesn't exist” method for creating pages. This way, your new page is linked and easily found with the link on the parent page.
- When using the “New Page icon" method, you can browse existing folder structures to put your page in the right spot. If you want to create a sub-page to an existing page, select the existing page and then add /mynewpagename to the end of the path. This will create a new folder out of the previous page namespace.
- For example, I can create a new page and click on the “Server Applications Main Page” folder, then click on the “Google Support Main Page” page. This will set the path to “server-apps/google”. Then, I add /examplepage to the end which will make the path "server-apps/google/examplepage", which will create a page called “examplepage” at that URL.
There are two primary methods for creating Wiki pages: Using the “New Page” icon or browsing to a page that doesn't exist.
¶ New Page icon
- Click the “New Page” icon in the top-right corner
- In the “Select New Page Location” window, click into the folder window to navigate to the appropriate subfolder
- The page name will change after clicking on the subfolder to something like /server-apps/google/new-page. Change the “new-page” to the name of the page you want to create.
- Click Select
- Select the editor you want. Visual Editor is the easiest to use and will be the typical page
- Add a title and short description to the page.
- Verify that the path is in all lowercase
- Click OK
- Add page content
- Click “Create” in top-right corner.
¶ Browse to a page doesn't exist
- Browse to a page that doesn't exist. It will say that the page does not exist yet.
- If you have permissions to create a page in that namespace, it will allow you to click “Create Page”
- Click Create Page
- Select the editor you want. Visual Editor is the easiest to use and will be the typical page
- Add a title and short description to the page.
- Verify that the path is in all lowercase
- Click OK
- Add page content
- Click “Create” in top-right corner.
¶ How to insert pictures into a page
- In the page you are editing, click the media icon in the top actions bar
- In the “Assets” section of the popup, click on the folder in the namespace you're page is located in (ex. “aboutus”, “public”, “districts”,"server-team", etc.)
- Once you are in the folder for the particular page's namespace, feel free to create a subfolder as needed. For example, under server-team, we will create subfolders called aws, microsoft, veeam, etc. In the aboutus folder, create a subfolder with your name.
- Once you are in the correct folder for your page, click Browse on the right side and select the photo to upload and then click UPLOAD
- Select the file the should now be in the folder on the left and click Insert
- If you are using the Visual Editor, you can resize the image by clicking one of the corners and shrinking or expanding
¶ Other Tips and Tricks
- Do you like that Table Of Contents in the page? Create those using the Heading formatting feature as you build your page. Just highlight the section name (like “Other Tips and Tricks” on this page) and change the heading to Heading1. You can get the sub-sections by using Heading2, etc.
- When creating a link to another wiki page, highlight the word(s) you want to be the hyperlink and click the hyperlink icon in the toolbar at the top of the screen. You do not have to enter the full URL for “internal” wiki links, but just the namespace portion of the link. For example, creating a hyperlink to https://wiki.swmitech.org/aboutus/mikecoats you can use that full URL or, just /aboutus/mikecoats Both work.
- If you would like to embed a YouTube video, create a page using Markdown (or convert an existing page to Markdown) and then paste in the YouTube embed code for the URL.
asdfnasldfkjasldfkja
¶ This is information