Difference between revisions of "Wiki Team/Guide/Page Deprecation"

From Sugar Labs
Jump to navigation Jump to search
(add link)
m (Refresh guideline)
 
Line 1: Line 1:
−
{{TOCright}}
+
The purpose of marking a page as deprecated is to inform visitors of content that is no longer valid and should not be used any further.
−
==Introduction==
 
−
This section deals with how to mark pages in the Sugar Labs wiki as deprecated.
 
  
−
The purpose of marking a page as deprecated is to inform visitors of content that is no longer valid and should not be used any further.
+
There's 2 related templates, '''[[Template:Dated]]''', for pages with stale or otherwise out-of-date information–but that in general just needs an update, and '''[[Template:Graduate]]''', for pages that should be graduated to https://github.com/sugarlabs/www-sugarlabs and then marked as deprecated.
  
−
There's another related template Template:Dated that should be used for pages with stale or otherwise out-of-date information—but that in general just needs an update. https://wiki.sugarlabs.org/go/Template:Dated
+
'''Note:''' Before marking a page as deprecated, make sure you have confirmed that the page content really is no longer valid (or that it has been replaced by more current information). It may be helpful to talk with someone who has recently edited the page, in case you have doubts.
  
−
==Before you mark a page as deprecated==
+
To deprecate a page, include the Deprecated template:
−
Before marking a page as deprecated, make sure you have confirmed that the page content really is no longer valid (or that it has been replaced by more current information). It may be helpful to talk with someone who has recently edited the page, in case you have doubts.
 
  
−
==Deprecate the Page==
+
<pre>{{Deprecated | some text pointing to an [[alternative page]] or http://some.url or just explaining why.}}</pre>
−
The way to deprecate a page is to include the Deprecated template.
 
−
<pre>{{Deprecated |some text pointing to an [[alternative page]] or http://some.url or just text.}}</pre>
 
  
 
The template takes an extra (optional) parameter that can basically be any text and will be displayed right after the warning sign.
 
The template takes an extra (optional) parameter that can basically be any text and will be displayed right after the warning sign.
  
−
==== Deprecated Category ====
+
=== Deprecated Category ===
−
Deprecated pages are marked as belonging to the [https://wiki.sugarlabs.org/go/Category:Deprecated Category:Deprecated].
+
 
 +
All deprecated pages are listed in [[:Category:Deprecated pages]]
 +
 
 +
An example of a deprecated page is [[Wiki_Team/Roadmap]]
  
−
[[Category:Wiki]]
 
 
[[Category:HowTo]]
 
[[Category:HowTo]]

Latest revision as of 12:17, 14 May 2016

The purpose of marking a page as deprecated is to inform visitors of content that is no longer valid and should not be used any further.

There's 2 related templates, Template:Dated, for pages with stale or otherwise out-of-date information–but that in general just needs an update, and Template:Graduate, for pages that should be graduated to https://github.com/sugarlabs/www-sugarlabs and then marked as deprecated.

Note: Before marking a page as deprecated, make sure you have confirmed that the page content really is no longer valid (or that it has been replaced by more current information). It may be helpful to talk with someone who has recently edited the page, in case you have doubts.

To deprecate a page, include the Deprecated template: 

{{Deprecated | some text pointing to an [[alternative page]] or http://some.url or just explaining why.}}

The template takes an extra (optional) parameter that can basically be any text and will be displayed right after the warning sign.

Deprecated Category

All deprecated pages are listed in Category:Deprecated pages

An example of a deprecated page is Wiki_Team/Roadmap

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Wiki_Team/Guide/Page_Deprecation&oldid=98447"