Wiki Best Practices

Organizing Content

Page Hierarchy

For a simple Wiki, a single level of files may be sufficient. For more complex Wikis, however, GitLab supports hierarchies of folders and Wiki pages which can be used to group like content together.

Using a page hierarchy requires that you change the way you specify links.

⚠️ You can move pages around in the hierarchy via the web GUI, but moving a page this way does not update any existing links. So, a bit of advance planning or outlining for you hierarchy will pay off.

Linking best practices

1. Use Wiki links generously, and think about how a reader might want to navigate the document. (Don't be afraid of cross-linking to any page in the Wiki - this allows navigating to related concepts that might not fit in a normal hierarchy)
2. Organize content in hierarchy/outline rather than very looooooong pages. This provides navigation based on topics, sub-topics, sub-sub-topics etc
3. Use Wiki links vs. absolute paths, i.e.,