Contributing [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Contributing to the FreeBSD Wiki =====

===== Introduction =====

This page outlines easy things that anyone can do to improve the wiki. If you have any questions or ideas for this page, get in touch with [[/WikiAdmin|WikiAdmin]].

===== Incorrect and Better Markup =====

  - Remove (replace) absolute Wiki links with standard wiki links. Here are 

  - Remove (replace) hard-coded (unprotected) email addresses with [[HelpOnMacros/MailTo|]] macro. Here are 

  - Remove spurious horizontal rules. Here are  (with some false positives, like those in ''%%{{{ }}}%%'' codeblocks).

  - Replace manual or hardcoded references or footnotes ([X]) with [[/HelpOnMacros#Others|]] macro.

===== Content Accessibility & Readability =====

  - Add [[/HelpOnMoinWikiSyntax#Headings_and_table_of_contents|Table of Contents]] to the top of pages where appropriate, such as long and or complex pages with deeply-nested section hierarchies.

  - Format text that references file contents or system commands using [[/HelpOnFormatting#Code_blocks|codeblocks]] or [[/HelpOnFormatting#Typeface|monospace]] markup. Use monospace for single-line or inline, and codeblocks for multi-line content.

  - Format (prefix) system commands that don't require root ''%%$%%'', and ''%%#%%'' commands that require root.

  - Add //[[/HelpOnLinking#Linking|linktext]]// to bare URLs, unless it doesn't make sense to do so. Helps readability, and search engines.
    * Example: ''%%[[http://example.net/|example site]]%%'' not ''%%http://example.net/%%''.

  - Spell-check and proof-read articles. See ''%%Menu: More Actions -> Check Spelling%%''.

  - Review a [[/RandomPage|RandomPage]] and improve it.

  - Standardize page organisation.
    - Use "standard" titles and section names like "Introduction", "Contacts" or "Resources"
    - Add a Table of Contents after an Introduction section.

===== Content Structure and Discoverability =====

  - Review [[/OrphanedPages|OrphanedPages]] for linking and/or categorisation opportunities.
  - Review [[/AbandonedPages|AbandonedPages]] for categorisation (eg: [[/CategoryStale|CategoryStale]]) or deletion opportunities.
  - Review [[/WantedPages|WantedPages]] for new page, removing accidental linking opportunities.
  - Review [[/CategoryStale|CategoryStale]] pages for content refresh or deletion opportunities.
  - Review [[/CategoryNeedsContent|CategoryNeedsContent]] pages for opportunities to "flesh out" pages to add more value.
  - Move pages that appear predominantly personal projects, work or references, to that person's Personal/namespace (Fix referent links after doing this).

===== Duplicate, Redundant or Outdated Content =====

Information that is duplicated, redundant (provided elsewhere), or otherwise requires updating in multiple places if the name or reference changes, should be removed, and replaced with a link to the 'canonical reference'.

  - Replace %%%%''%%username@%%''%%%% %%FreeBSD%% login (committer) references with a link to the committers home page. If the home page does not contain username/login reference, add it.
  - Everything in this wiki is //%%FreeBSD%% related//. Remove references to //%%FreeBSD%%// or //%%FreeBSD%% Project// unless required to maintain meaning or context.
    - This includes page names.
  - Remove references to attachments / URLs that no longer exist.
    - Try to find replacements/alternatives if possible.

===== Content Language =====

  - Remove or replace //you//, //your//, //his//, //her// language unless required to maintain meaning or context.
  - Use singular ''%%they%%'' for 3rd-person pronouns unless a specific pronoun is requested by someone.

===== Potential Things =====

**Don't do these things yet**. If you'd like to, discuss on #freebsd-wiki (Libera.Chat IRC).

  - Rename pages with titles in abbreviated/acronym form to their %%FullNotAcronymName%%.
    - Example: ''%%ASLR%%'' -> ''%%AddressSpaceLayoutRandomization%%''.
    - **NOTE**: Check for and update all referents when renaming pages. If referents exist in Google/Search Engine, create a redirect at the old name pointing to the new one.
  - Add link text (''%%|link text%%'') to bare URLs. Search: [[https://wiki.freebsd.org/FrontPage?action=fullsearch&context=180&value=regex%3A%22%28%5C%5B%5C%5B%5Cs*%5Ba-z%5D%2B%5B%5C%3A%5D%5C%2F%5C%2F%5B%5E%5C%7C%5C%5D%5Cs%5D*%5Cs*%5C%5D%5C%5D%7C%5B%5E%5C%5Ba-z%5Cs%5D%5Ba-z%5D%2B%5B%5C%3A%5D%5C%2F%5C%2F%5B%5E%5C%7C%5C%5D%5Cs%5D*%29%22&fullsearch=Text|Pages containing bare URLs]] (test regex, has false positives)

  - Replace links to external documents (PDF, images, etc) with attachments.
  - Add [[/HelpOnLinking#Embedding|width and height to image attachments]] so they're rendered //nicely//.
  - Creates [[/HomePage|HomePage]]'s for People without them (See [[/WantedPages|WantedPages]]). Need to figure out how to subscribe those people to their pages before we do that.

----

{{tag>Wiki Contributing}}