Differences between revisions 2 and 20 (spanning 18 versions)
Revision 2 as of 2010-10-15 06:08:30
Size: 4077
Editor: mpm
Comment:
Revision 20 as of 2013-08-31 19:42:14
Size: 459
Editor: JeffryPic
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Wiki Cleanup =

This describes plans for improving the Mercurial wiki.

<<TableOfContents>>

== Goal ==

The wiki aims to be a moderately coherent body of documentation to supplement the following resources:

 * Mercurial's [[http://selenic.com/hg/help|built-in documentation]] and [[http://mercurial.selenic.com/wiki/ManPages|man pages]]
 * The [[MercurialBook|Mercurial book]]
 * Mercurial's [[MailingLists|mailing lists]]

As such, it makes sense to have things like the following:

 * in-depth information and [[CategoryHowto|How-tos]] that are beyond the scope of the book
 * information about extensions and third-party tools
 * links to other resources
 * FAQs, tips, and other useful recipes
 * best practices
 * migration and conversion assistance
 * documentation of internals
 * development plans and other information for contributors

Things that probably ''don't'' make sense for the wiki include:

 * discussion - use the mailing lists
 * non-best practices
 * advertising

== Improvement plan ==

As of October 2010, much of the wiki suffers from:

 * inconsistent formatting and style
 * poor linking and organization
 * excessive duplication
 * pages that duplicate help or book content
 * lots of stub pages
 * random commentary and non-canonical advice
 * irrelevant pages courtesy of Moin

This page describes a collection of janitorial tasks for incrementally improving this situation over time.

If you have questions, please ask on [[IRC|IRC]].

=== Spam removal ===

Watch the RecentChanges page for the introduction of spam pages and other vandalism.
Revert vandalized pages and delete newly-created spam pages and add offending users to BannedUsers (or ask an admin).

=== Update pages and page names to match wiki style ===

See the [[WikiStyleGuide|wiki style guide]] for guidelines on page style and edit pages appropriately.
Add pages that need further editing to CategoryAudit.

Add redirects to renamed pages to avoid breaking existing links.

=== Remove discussion ===

Some pages have discussion questions that belong elsewhere. Either move these to a '/Talk' subpage or delete them.

=== Fix orphaned and abandoned pages ===

Visit OrphanedPages and AbandonedPages to find pages that need attention and add appropriate [[CategoryCategories|categories]] and links from other pages.

=== Mark pages needing merging ===

There are a number of pages that contain very similar content on the wiki. Use the search tool to find related pages and add them to CategoryProposedMerge.
Include a marker like the following under the title of each page to be merged:

{i} This page's contents should be merged with PageFoo and PageBar.

{{{
{i} This page's contents should be merged with PageFoo and PageBar
}}}

If you undertake the consolidating of page contents, remember to redirect the old pages to the new one.

=== Link to built-in help and book topics ===

There are a lot of topics on the wiki that are now covered in help, manpages, and the book. Add links to such content where appropriate. To link to built-in help topics (for instance the [[http://selenic.com/hg/help/branch|hg branch]] command), use a link like the following:

{{{
[[http://selenic.com/hg/help/branch|hg branch]]
}}}

For pages whose contents are completely covered by these resources, see the section below on page deletion.

=== Page deletion ===

Add pages that don't seem appropriate for the wiki (irrelevant stubs, random commentary, etc.) to CategoryProposedDeletion and include a marker like the following under the title:

/!\ This page is proposed for deletion.

{{{
/!\ This page is proposed for deletion.
}}}

Use the 'Local Site Map' action to find pages that link to a page and remove those links.

=== Fix broken links ===

Visit WantedPages and point broken links to appropriate pages or remove them as appropriate.

=== Expand stubs and create needed pages ===

Visit CategoryStubs and WantedPages and expand wiki content.

----
CategoryWiki
Alia is the name clients use to call to me but I don't that include when people use some full name.<<BR>>
<<BR>>
Vermont might be our birth place. I am really fond of horseback riding but I don't have the time lately. My job can be an administrative assistant but I have got already applied for a differnt one. I'm not are able of webdesign but you might like to check my website: http://targetedtraffictips.net/blog/uncategorized/pure-collagen-skin-care/

Alia is the name clients use to call to me but I don't that include when people use some full name.

Vermont might be our birth place. I am really fond of horseback riding but I don't have the time lately. My job can be an administrative assistant but I have got already applied for a differnt one. I'm not are able of webdesign but you might like to check my website: http://targetedtraffictips.net/blog/uncategorized/pure-collagen-skin-care/

WikiCleanup (last edited 2013-09-01 01:19:02 by KevinBot)