From Mageia wiki
Jump to: navigation, search
Drakconf multiflag.png
Other languages

English ; Portuguese (Portugal)


How does the todo-list work

This page is intended to organise the doc-team work. Anyone belonging to the doc-team can update this page and anyone belonging to the Mageia community can write a documentation page, listed here or not.

If you want to create a page for the documentation, we are happy for you to take the initiative. Before doing this, it is preferable to check that no other page covers partially or completely the subject you want to document. Consider also modifying a page which seems to be incomplete. If you intend to modify a page substantially, it is a good idea to mention it either in the mailing list doc-discuss or directly with the original writer.

If you start to work on one of the topics below, please post in the mailing list doc-discuss the link to the page you started here, together with your name and current progress. This information should be updated frequently, to avoid duplication or multiple contributors working on the same topic in parallel.

All you need to know about tools, report pages, management, mailing list, contact and so on can be found in our Doc_Team_Portal. If you get lost in all these pages, just send an e-mail to the doc-discuss mailing list saying what you want to do and we will be happy to give you a simple procedure.

Please, when a topic is done, don't delete it but cross it off the list instead. It is easier to follow the progress.

The whole documentation is divided into sections:

  • The official help, subdivided in "Classical installer help", "Live installer help" and "MCC help"
  • The wiki with the same subdividing as its portal: Documentation

Each section is divided in 3 parts:

  • What is existing gives links to where it is possible to find the already exiting documentation
  • What is urgent lists the top wishes
  • Else to do lists the other wishes.

Official help

The Official help is important for the Mageia image and must be neat and tidy. Calenco is the tool we use for the Official help, see How_to_write_and_translate_Mageia_doc#Write_or_update_original_doc.

We are looking for a documentation that is not only a description of what can be seen on the screen but a real relevant information with when possible:

  • main features
  • screen-shots
  • examples
  • common errors to avoid
  • troubleshooting (how to do a good diagnosis, what to check, ...)
  • known issues or bugs

Classical installer help

What is existing

The Installer official help

What is urgent

Always keep the official help up to date, write here what is not:

Else to do

Live installer help

What is existing

The official draklive help

What is urgent

Always keep the official help up to date, write here what is not:

Else to do

MCC help

What is existing

The official MCC help
See also the report page Calenco_Draktools

What is urgent

1 - Are still missing:

  • drakinviictus
  • draknetprofile
  • drakxservices
  • drakeups

2 - And some others have to be completed and/or checked:

  • diskdrake --fileshare
  • diskdrake --smb
  • drakboot --boot
  • draknetcenter (Network Manager, roaming)
  • drakconnect (missing exotic devices)

3 - To carry out the missing screenshots Missing_MCC_screenshots

Else to do

Wiki documentation

For practical information, have a look to How_to_write_a_wiki_page
Always begin by reading the existing pages that are near your subject, you will find material, maybe a new section is enough/better instead of a new page or a former page will become obsolete. That demands some search.

Dicovery of Linux and Mageia

What is existing

This page first section Documentation#Discovery_of_Linux_and_Mageia_.28For_newcomers.29

What is urgent

1 - To have a page about each desktop environment. The first time a newcomer looks at his/her brand new desktop, it is not obvious that there are components of it that are Mageia and others that come from the Desktop Environment, especially if the user has come from Windows where everything is Windows. We would like to have for each DE a simple page with:

  • a large screen-shot showing:
    • a landmark on the Mageia tools (mgaapplet, netapplet, ...)
    • a view of the menu
  • how to get the DE tools
  • how to get the MCC tools
  • for the most important features, what can be configured by the MCC tools, or by the DE tools, or both,
  • a link towards the DE website
  • everything else that could be discussed on the mailing list

2 - Update every page quoting LXDE, this DE is soon obsolete.

Else to do

Any help to welcome the newcomers

Installation

What is existing

This page Installation section Documentation#Installation

What is urgent

1 - Which hardware for Mageia
2 - Choosing a desktop, may be connected with the previous line?
3 - Partitioning, idea of pages name:

4 - Creating a persistent USB Stick. A discussion[1] in forum is to formalize.

Else to do

1 - Preparing a medium
2 - Using the test distribution Cauldron
3 - Installing and removing software from Mandriva. To have a look to this page before deleting. Is there anything to save ?
4 - Installing and configuring the bootloader:

5 - Update every page quoting the Dual Arch medium, it will soon disappear.
6 - Installing_Mageia to be revised or deleted

MCC

What is existing

This section about MCC tools: Documentation#MCC_tools_.28also_called_Draktools.29

What is urgent

Else to do

Configuring and using Mageia

Software

What is existing

This section about software: Documentation#MCC_tools_.28also_called_Draktools.29

What is urgent

1 - Network sharing. NFS - Samba, etc.

Else to do

1 - Social networks
2 - The page about the superuser Root must be completed

Hardware

What is existing

This section about hardware: Documentation#Hardware

What is urgent

1 - Configuring and using a 3G or 4G access
2 - Which hardware for Mageia: Explain that the most of the hardware is supported, which hardware needs special drivers or is known for not working.
3 - systemd: The aim of systemd, how it works, main commands to get infos...
4 - Sound troobleshooting. Pulse Audio - pavucontrol - Alsa - Phonon - KMix - alsamixer - Drivers etc.

Else to do

1 - Installing proprietary graphic drivers (Nvidia and ATI)
2 - Configuring the hostname
3 - How to mount a USB stick. Seems to be a draft, to be completed

The community

What is existing

This section about the Community: Documentation#The_Community

What is urgent

1 - How to use Git. Seems to be a draft, to be completed.

Else to do

Other documentation actions

(We can list here the decided actions that aren't included either in Official help or Wiki documentation.)

Docteam meeting agenda submissions

  • Our meeting agenda submissions page.
    • Regardless of date order, perhaps suitable topics (esp if there are more than enough to be dealt with in one meeting) could be selected by: priority topics; topics not dealt with in the previous meeting due to lack of time; topics which are related?
    • Meeting Chair(s) - team leader to update the status of submissions?