Help:Contents

From OCS Inventory NG
Jump to: navigation, search


Getting started

First of all, you may consult the MediaWiki User's Guide for information on using the wiki software. If you wish to contribute to OCS Inventory NG Documentation, you will also learn how to:

  • create or update pages,
  • format text into pages,
  • upload and use images in pages,
  • create or update tables,
  • create or update links between pages,
  • create or update sections to automatically generate table of contents,
  • create new categories.

In order to enhance or translate OCS Inventory NG Documentation, you must create an account and/or log in.

To only take a look at OCS Inventory NG Documentation, just navigate to Documentation menu.


How OCS Inventory NG Documentation is organized ?

OCS Inventory NG Documentation is located under Documentation namespace. It has been divided into 9 pages :

  • Setting up management server
  • Setting up agent on client computers
  • Querying inventory results
  • Administration of OCS Inventory NG
  • Using IP discovery feature
  • Deploying packages or executing commands on client hosts
  • Management server tuning
  • Backup/restore of OCS Inventory NG database
  • Common errors


How OCS Inventory NG Wiki is organized ?

OCS Inventory NG Wiki is organized into namespaces to help to create pages in good places. Here is an overview of namespaces:

  • Documentation namespace where you can find the main OCS Inventory NG documentation.
  • Admin center namespace for usefull scripts and tips for tools
  • Howtos namespace for howtos and tutorials for specific operating systems or specific features.
  • Tools namespace for howtos to help using different OCS Inventory NG Tools.
  • Developers namespace where you can find notes and explanation about product developement.
  • Beta_testers naemspace for documentation of new OCS Inventory NG features.
  • Contributors namespace for OCS Inventory NG contributors.
  • Events namespace for OCS Inventroy events informations.
  • Misc namespace for miscellaneous pages.

Each namespace contains a "Main Page" with links to the pages of the namespace.


How to create a new page ?

If you want to create a new page in OCS Inventory NG wiki, you first have to choose a namespace where you will add your page in concordance with your page subject.

After choosing you namespace, you have to edit the "Main page" of the namespace. "Main" namespace pages can be found by adding :Main to namespace names in URL : Developers:Main, Howtos:Main, Tools:Main, etc...

Now, add a new internal link in the "Main" namespace page. E.g : [[Namespace_name:My_new_page|My new page description]]).

Then, just save the "Main" namespace page, clic on the new link, edit and save your new page.

Example

I want to create a page to exeplain how to install OCS Inventory NG server on my favorite Linux distribution. I chosse the Howtos namespace to put my new page.

So, I edit the Howtos:Main page and I add a link like this :

 [[Howtos:Install_ocs_on_myfavoritedistribution| How to install OCS server on my favorite distribution]]

I save the page and I clic on the link. I now edit the page, add my documentation and save the page.

Voilà! My documentation is added to OCS Inventory NG Wiki !

How to translate a page ?

To translate a page into a new language, you need to create a new page called Page name/code, where code is replaced by the appropriate language code in both instances, and whose contents should be copyied and translated from an existing language that you understand - preferrably the English version (see Template:Languages for a list of supported languages).

Page must include call to template {{Languages|Page name}} at his top.

If you are only able to do a partial translation (unable to translate depending pages from example), then any missing content (red links) will be in English instead.

Important note: Please make sure you have read Project:Language policy before starting a new translation.