¶ ACEP Wiki: Getting Started
Welcome to the ACEP Wiki. This page will help you understand how to get started managing content on the ACEP Wiki.
¶ Purpose
The purpose for the ACEP Wiki is to have one place to locate searchable ACEP internal documentation, processes, procedures and resources. The target audiences for ACEP Wiki content are the ACEP faculty, staff and student.
If other resources have already been developed, that is ok. We can simply create ACEP Wiki pages for those resources and link to them from the Wiki.
¶ Getting Access
Before you can edit content on the ACEP Wiki you will need to:
- Login to https://wiki-dev.lab.acep.uaf.edu/ with your UA username and password by clicking
the person icon in the top right of the page. - Email uaf-acep-ci@alaska.edu to request Wiki Edit Permissions for your account.
- After getting your account, you may need to re-login for permissions to update.
¶ Content Areas
ACEP Wiki content should be populated into one of two content areas:
¶ Public
For pages that are accessible from the Internet and do not require logging in to access:
- https://wiki-dev.lab.acep.uaf.edu/ - Home Page
- https://wiki-dev.lab.acep.uaf.edu/public - Base URL for Public Page
¶ Internal
For pages that requires a UA login to access:
- https://wiki-dev.lab.acep.uaf.edu/[PAGE_PATH] - For all other pages
¶ Wiki Pages
¶ Creating a New Page
To create a new page:
- Got to: https://wiki-dev.lab.acep.uaf.edu/
- Login
- Click on the New Page icon in the top right hand corner
¶ Selecting Page URL Path and Menu Location
Select the URL path (e.g. /teams/wiki-team) for where the page will be located in the Wiki Menu Navigation structure:
Please note best practices on naming URL Paths and Page Names when creating new pages.
¶ Select your Page Editor
- Most likely the Visual Editor or Markdown
¶ Naming your Page
- Title: What you name page will look like in the Menu navigation.
¶ URL Paths
The URL Path refers to the part of the URL:
- https://wiki-dev.lab.acep.uaf.edu/en/teams/wiki-team
that follows the base path. For the example above the Page URL Path is: teams/wiki-team. And this will also place the wiki-team page under the teams page hierarchy in the navigation menu.
When it comes to website URL page path naming conventions, there are several best practices that can enhance both user experience and SEO. Here's a good standard to follow:
- Use Lowercase Letters: Always use lowercase letters. This avoids confusion since URLs are case-sensitive in some servers.
- Be Descriptive and Concise: Names should be intuitive and describe the content of the page. However, they should also be concise to avoid overly long URL.
- Use Hyphens to Separate Words: Hyphens (-) are preferred over underscores (_) for separating words. Search engines like Google treat hyphens as space, but underscores are not treated the same way, which can affect SEO.
- Avoid Special Characters: Stick to alphanumeric characters and avoid special characters like &, %, $, etc., as they can cause issues with browsers and are not SEO-friendly.
- Include Keywords: For SEO purposes, include relevant keywords in your URLs. But avoid keyword stuffing.
- Follow a Logical Structure: The path should reflect the site hierarchy, making it easier for users to understand where they are in the website's structure. For example, site.com/category/subcategory/page.
- Avoid Dynamic URLs When Possible: Static URLs are more user-friendly and better for SEO than dynamic URLs with parameters like ?id=123.
- Limit Folder Depth: Don't nest pages too deeply in multiple folders. This can make URLs very long and harder to understand.
- Use Canonical URLs: To avoid duplicate content issues, use canonical URLs when necessary.
- Consistency is Key: Be consistent in your naming conventions across the website. This includes consistent use of trailing slashes (or the lack thereof).
These guidelines are widely recognized and should work well in a variety of contexts, including the Debian environment you're familiar with. They enhance user navigation and improve the site's visibility and ranking in search engines.
¶ Page Names
Page Name should be set to how you want the page name to appear in the Wiki Navigation Menu.
¶ Moving a Page
- Navigate to the page you want to move.
- Select Page Actions > Move / Rename
- Edit the Page URL Path
¶ Using FontAwesome Icons
This feature only work with Markdown pages. It is not available in the Visual Editor.
You can add FontAwesome Icons to your wiki pages.
- Go to: https://fontawesome.com/v5/search?q=icon&o=r&m=free
- Search for a free icon: e.g. book
- Click on the Icon you would like to use
- Copy the HTML code for the icon and past into your Wiki page text.
<i class="fas fa-book"></i>The icon will render in your Markdown page.
¶ Wiki.js Documentation
For more advanced documentation on how to use Wiki.js please see the documentation: