Jump to content

Help:Wiki editor's guide

From Nura Wiki

This page contains various guidelines and tips on how to make edits. See the Where to improve section the know where to start contributing.

Rules and style guide

Before contributing to the wiki, make sure to familiarize yourself with the rules and style guide. They contain a set of guidelines for writing clear and consistent wiki pages.

Syntax

Main article: Wiki syntax

The Nura wiki is powered by MediaWiki, the same software that powers Wikipedia, but keep in mind that our configuration only uses the source editor. With the source editor you have to know a bit of MediaWiki syntax, to make your edits look just the way you intend them.

A complete guide to MediaWiki syntax can be found on their wiki: Help:Formatting.

Discussions & issues

Unlike most wikis, Nura wiki disables discussion pages. This is because the wiki-related discussions take place in the wiki repo on the Nura GitLab. Issues are there to discuss wiki improvement requests, and other things a normal user can't fix on their own. It can also be used to discuss something before making a change.

For real-time discussion, there is dedicated wiki chat: #wiki:nura.eco (on Matrix) / #postmarketos-wiki (on OFTC, Webchat).

Contacting other editors directly is still possible: go to their user page, select the "Discussion" tab, and click "New topic" in the top bar to add a new discussion topic to their talk page.

Page management

Creating a page

To create a new page, type its name into the search bar on the top of this page, or your browser's URL bar right after ...nura.eco/wiki/. Then, click the "Create this page" link on the page. This could be done with a "Create new page" link in the toolbar, but this has not been configured yet on this wiki.

Device pages have a device infobox that contains information about the status of the device. The data on the device infobox is automatically generated from the data in the infobox.

For more information about editing and creating device pages, see Help:Device Page and Template:Infobox device.

Deleting a page

Pages that should be deleted can be added to the table on Pages needing deletion.

Query tables

For information about managing automatically generated tables, see: Wiki syntax#Query tables

Making your user page

Navigate to your user page by clicking on the username in the top right.

When you sign up, the contents of the "Personal biography" you provided when creating your account are added to your user page. While you're editing your user page, you might want to add your owned devices, and various userboxes. See Wiki syntax#User page templates for reference.

Subpages

Subpages can be useful for indicating when a page is intended to extend the contents of another. Adding a subpage involves:

  • Creating a new page named Pagename/Subpage, where Pagename is the name of the main page, and Subpage is the name of the subpage.
  • Adding the {{Subpage of|Pagename}} template to the top of the page (this makes a link to the previous page show up).

You can also create a subpage of a subpage, with Pagename/Subpage/Subsubpage). Now to show the full link tree on the parent page, use {{Subpage of|Pagename|Subpage}}.

Note Adding the {{Subpage of|...}} template is not needed under user pages.
On user pages, MediaWiki's default support for subpages is enabled, which means the navigation appears automatically. On non-user-pages, subpages are disabled, since they would interfere with any wiki pages with / in the title, which is used pretty often; thus, the {{Subpage of|...}} template is a manual workaround to get the links to appear. See Help:Subpages for the relevant MediaWiki documentation.

Creating a draft

You can create a draft by creating a subpage under your user page, for example User:YourUsername/Draft:Page title.

Uploading images

You can upload images by going to Special:Upload. Remember to set the license for the file you are uploading, and do not reupload others' images without permission.

See also Making good photos if you're planning to upload photos of devices and the like.

Where to improve

These are some starting points for wiki improvements for both new and experienced Nura users. See below to check which pages need more work:

Smaller fixes

Note The goal is that over time this accumulates into a full user helpcenter resource, documenting answers to any common beginner question (even from casual users).
  • Fixing some wording or formatting issues according to the style guide.

Wiki pages on certain software/packages

Interfaces

If you are in some way involved with the development of one of the mobile & desktop interfaces, make sure to add:

  • Guidelines to issue reporting/feature requests to the the interface wiki page. This would increase effective up-streaming of issues.
  • Usage tips, so that our users will be more informed about certain usage tricks.

Mobile-friendly (Linux-native) apps

For apps that have mobile Linux in mind, the wiki page on those apps should be useful to the reader. This can be done with:

  • Playtesting - When the app is tested on Nura (with a mobile device if possible) you can add a description as to why it is a useful app for Linux mobile, or additional configuration tips if needed.
  • External links pointing to further resources. This will help our userbase with getting to know the app better, and also improves discoverability.

See also