Mailinglist Archive: yast-devel (55 mails)

< Previous Next >
[yast-devel] Tips for adding YaST pages to opensuse wiki
Hi all,

this is about creating new pages for http://en.opensuse.org/Portal:YaST either by copying a page from http://old-en.opensuse.org/YaST or writing a totally new page.

Namespace
---------
The namespace is in front of the page name and is separated by ':'.

Namespaces used for YaST pages are:
openSUSE: all articles concerning openSUSE projects and teams,
e.g. openSUSE:YaST_development, openSUSE:YaST_team
SDB: help, Howtos, support, e.g. SDB:YaST_tricks,
SDB:YaST_remote_logging_during_installation
User: for the YaST teams members
Portal: overview over a topic, entry point, e.g. Portal:YaST,
Portal:Libzypp, Portal:Libstorage

see http://en.opensuse.org/Help:Namespace

Name of a the page
------------------
The name of the page should be readable like a headline/a short description of the content (words seperated by '_' and lower case writing). Not all YaST pages respect this, good examples are openSUSE:YaST_development, openSUSE:Report_a_YaST_bug, SDB:YaST_remote_logging_during_installation

Category
--------
Categories should be added to the pages to be able to find/list the pages more easily.

[[Category:YaST]]
Should be added to all YaST pages (got listed in 'All of YaST' on
right side on http://en.opensuse.org/Portal:YaST)

[[Category:SDB:YaST]]
YaST related SDB articles (got listed when selecting 'SDB:YaST' on http://en.opensuse.org/Portal:Support_database).

see http://en.opensuse.org/Help:Category

Hints if old pages are copied
-----------------------------

1. Adding a TransferNote to the old wiki page

To add a transfer note is recommended for important pages or if you have found recent contributions/changes in the page history. The note points to the new page, like:
This article has been transferred to the http://en.opensuse.org
/openSUSE:YaST_style_guide .
Please use new location for your contributions.

In first line add {{TransferNote|<new page>}}.

2. Adding an Info to new wiki page

If you are unsure whether the content of an old wiki page is still valid, add an info to the page on new wiki, like:
This page is NOT up to date. Some information might not be valid any
longer.

Add {{Info|<the information>}} at the beginning.

Ideally find someone who takes care and checks/updates the page.

Greetings
Gabi

--
Gabriele Mohr
SUSE LINUX Products GmbH, GF: Markus Rex, HRB 16746 (AG Nürnberg)
Maxfeldstr. 5 Tel: +49 911 740 53 362
90409 Nürnberg Email: gs@xxxxxxx
-----------------------------------------------------------------
--
To unsubscribe, e-mail: yast-devel+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: yast-devel+help@xxxxxxxxxxxx

< Previous Next >
This Thread
  • No further messages