Difference between revisions of "SME Server:Documentation:Technical Manual:Chapter1"

From SME Server
m (New page: ==Chapter 1. How you can help== ===Documentation=== Documentation for SME Server was inherited from the prior distribution maintainers, e-smith and mitel. Their work gave SME a great base...)
 
Line 1: Line 1:
==Chapter 1. How you can help==
+
==Chapter 1. Finding Answers===
 +
Ideally most of the information you need to run and configure your server will be in the manual
 +
If something you need isn't, work your way down the resources that follow.
 +
If it's appropriate, you can add the material to the wiki, if unsure ask.
  
===Documentation===
+
===Manuals====
Documentation for SME Server was inherited from the prior distribution maintainers, e-smith and mitel.
+
[[/sme7/docs SME Manuals]]
Their work gave SME a great base to work from.
+
Four Manuals are being written, for the User, Administrator, Technician and Developer.
  
The current developers have continued to improve the SME Server software and to reflect these improvements the Documentation has to develop too. These wiki-based manuals have been put in place to allow anyone to update or add new sections where they see fit.
+
====Bug Tracker====
 +
Find, report and fix bugs here http://bugs.contribs.org/
  
 +
You don't have to be a programmer to help or use the bug tracker.
 +
Bugs also include fixing things and making suggestions on documentation, translations and the SME Server web sites.
  
===Bug and New Feature Verification===
+
General Instructions for using the bug Tracker are here [[http://www.bugzilla.org/docs/tip/html/using.html Using Bugzilla]]
Please help us to make our software as reliable as possible. Your role in that is to report possible bugs only via the bug tracker, and to encourage others to do the same. Thanks.
 
  
[[http://www.bugzilla.org/docs/tip/html/bugreports.html#fillingbugs Reporting a New Bug]]
+
====Searching for bugs=====
If you have searched the Manual and Bug Tracker and not found an answer or someone else's report that matches yours, you should register on the Bug Tracker and enter a new bug. The debugging process of any issue requires active participation on the part of the reporter, providing further information and clarification of the problem.
+
To help find bugs, some prepared searches have been added in page headers, with more [[/howto/BugzillaReports BugzillaReports]] here
  
* So how do I know it is a bug?
+
'''Simple search'''
You don't need to. If there's any chance that it is a bug, please report to the bug tracker. It doesn't matter whether anyone else has seen it. It doesn't matter whether anyone else has a theory as to what is happening. You have noticed something that doesn't seem to work right, so just report it. Please.
+
At the top of the search page choose 'Find a specific bug'
 +
Select a Status and a Product category and enter your search term
  
 +
'''Advanced search'''
 +
At the top of the search page choose 'Advanced search'
  
To enter a bug choose a category, component, fill in the details of the bug, and commit.  
+
You can restrict searches by using a selection or multiple selections of a category  
Please use a descriptive Summary, as most of the header searches just show the Summary
+
Use Control Click to select/deselect from selection sets, if none are selected all are.
'panel errors' is not helpful, what panel, what errors ?
 
'Add option to limit mailman web access ' explains the topic very well
 
  
Anyone reporting problems, ask yourself these important questions, so that you
+
typically you may restrict Product to use  '7.x/Future/Documentation'
know what to tell the developers in the bug report:
+
and enter a search term into either 'Summary' or 'A Comment'
  
# What version am I using and are there any contribs installed or other customisations?
+
eg. Status = CLOSED, Resolution = WONTFIX, Summary = yum
# What did I do?
+
will return about 7 bugs
# What did I expect to happen?
 
# What happened?
 
# What do the logs say?
 
  
 +
eg. Status = CLOSED, Resolution = WONTFIX, A Comment = yum
 +
will return about 17 bugs
  
[[http://www.bugzilla.org/docs/tip/html/lifecycle.html Lifecycle of a Bug]]
+
*Modifying your search
If you find a bug you can work on, eg updating information on the wiki, do so.
 
There are likely to be a lot of these as they were generated before the wiki was in place.
 
  
In this example of adding documentation, after you have updated the wiki, return to the bug
+
- Click on the hyperlinked headers to sort your list
post brief details of the fix, and how to verify it, eg 'updated wiki re: passwords' and give the URL
 
then change the Status to 'Resolved - Fixed'.
 
  
Someone else can then review your changes and change the Status from 'Resolved - Fixed' to Verified and the bug is finished.
+
- Click 'Edit Search' near the page footer
Bug Tracker Administrators Close bugs in SME Current or SME Future, but the reporter or maintainer can close in other sections.
+
* you can adjust your selection sets
+
* add a search tern in the summary or comments fields
 +
* restrict the dates, eg between 365d and Now the last year,  60d and 7d from 2months ago but not the last week
 +
* bugs you are working on or watching, add you email address to the left field in email and numbering and check cc:, commenter, etc
  
===Programming===
+
- If you have a favourite search,
 +
* when the bug list is displaying, add a name in the  Remember field, these will show in your footer
 +
* add the search to the  [[/howto/BugzillaReports BugzillaReports]] page
  
FIXME
 
See the Developers manual
 
  
===Maintaining existing Languages===
+
see [[http://smeserver.sourceforge.net/sme7/tech/Chapter5#h1127-3 Reporting and working on bugs]]
  
Changes to Existing Language sets are posted to the Translations section of the Bug Tracker.
 
Making a patch to keep your language updated isn't difficult, follow these steps
 
  
Obtain an original file that you are going to modify, it will usually be a translation of a panel, eg.
+
===Forums===
/etc/e-smith/locale/en-us/etc/e-smith/web/functions/hostentries or
+
Currently here http://wiki.contribs.org/
/etc/e-smith/locale/fr/etc/e-smith/web/functions/hostentries
 
if a patch from the Bug Tracker is available it will guide you on what has changed
 
[[http://bugs.contribs.org/attachment.cgi?id=751]]
 
  
make a directory and copy your file there as name.old
+
There is an enormous amount of information here, a search can often find just the answer you are after.
make a copy name.new and edit it to suit
+
You can also find outdated, misinformed or wrong information.
  
from the command line create a patch
+
The aim should be to transfer valuable information into the Manual or a Howto (with a link in the Howto List)
diff -u name.old name.new > name.patch
 
  
add this to the existing bug or create a new one in Translations
+
If you can't find the information you are after then post to the forum which is full of friendly helpful people
 +
If applicable, document your answer in the wiki, so it becomes a definitive  answer and not just another hit on a search
  
 +
===How To's===
 +
HowTo's are documents to solve a particular problem
 +
There is a list of [[SME_Server:Documentation:HowTo|HowTos here]]
  
===Donations & Funding Work===
+
===F.A.Q.====
 +
[[SME_Server:Documentation:FAQ|Frequently Asked Questions]]
  
Help smeserver.org pay it's bills
+
This page is to be used to document problems that cannot or will not be fixed through development of SME7.
http://www.smeserver.org/index.php?option=com_wrapper&Itemid=34
+
If a problem is fixed it should be moved into the Manual or a Howto.
  
Pay a developer to add a feature you would like
+
 
Email a developer directly with your request or open a bug with your proposal
+
===Email Lists===
 +
There are a number of lists available to join at http://lists.contribs.org/mailman/listinfo
 +
 
 +
List descriptions and email archives are available.
 +
 
 +
 
 +
===Old Wikis===
 +
The wiki from the old sourceforge site is at: http://smeserver.sourceforge.net/HomePage
 +
 
 +
The wiki from the old Xoops site is archived at: http://no.longer.valid/phpwiki/
 +
Be aware that the vast majority of the information on the phpwiki outdated and incorrect.

Revision as of 07:59, 17 February 2007

Chapter 1. Finding Answers=

Ideally most of the information you need to run and configure your server will be in the manual If something you need isn't, work your way down the resources that follow. If it's appropriate, you can add the material to the wiki, if unsure ask.

Manuals=

/sme7/docs SME Manuals Four Manuals are being written, for the User, Administrator, Technician and Developer.

Bug Tracker

Find, report and fix bugs here http://bugs.contribs.org/

You don't have to be a programmer to help or use the bug tracker. Bugs also include fixing things and making suggestions on documentation, translations and the SME Server web sites.

General Instructions for using the bug Tracker are here [Using Bugzilla]

Searching for bugs=

To help find bugs, some prepared searches have been added in page headers, with more /howto/BugzillaReports BugzillaReports here

Simple search At the top of the search page choose 'Find a specific bug' Select a Status and a Product category and enter your search term

Advanced search At the top of the search page choose 'Advanced search'

You can restrict searches by using a selection or multiple selections of a category Use Control Click to select/deselect from selection sets, if none are selected all are.

typically you may restrict Product to use '7.x/Future/Documentation' and enter a search term into either 'Summary' or 'A Comment'

eg. Status = CLOSED, Resolution = WONTFIX, Summary = yum will return about 7 bugs

eg. Status = CLOSED, Resolution = WONTFIX, A Comment = yum will return about 17 bugs

  • Modifying your search

- Click on the hyperlinked headers to sort your list

- Click 'Edit Search' near the page footer

  • you can adjust your selection sets
  • add a search tern in the summary or comments fields
  • restrict the dates, eg between 365d and Now the last year, 60d and 7d from 2months ago but not the last week
  • bugs you are working on or watching, add you email address to the left field in email and numbering and check cc:, commenter, etc

- If you have a favourite search,


see [Reporting and working on bugs]


Forums

Currently here http://wiki.contribs.org/

There is an enormous amount of information here, a search can often find just the answer you are after. You can also find outdated, misinformed or wrong information.

The aim should be to transfer valuable information into the Manual or a Howto (with a link in the Howto List)

If you can't find the information you are after then post to the forum which is full of friendly helpful people If applicable, document your answer in the wiki, so it becomes a definitive answer and not just another hit on a search

How To's

HowTo's are documents to solve a particular problem There is a list of HowTos here

F.A.Q.=

Frequently Asked Questions

This page is to be used to document problems that cannot or will not be fixed through development of SME7. If a problem is fixed it should be moved into the Manual or a Howto.


Email Lists

There are a number of lists available to join at http://lists.contribs.org/mailman/listinfo

List descriptions and email archives are available.


Old Wikis

The wiki from the old sourceforge site is at: http://smeserver.sourceforge.net/HomePage

The wiki from the old Xoops site is archived at: http://no.longer.valid/phpwiki/ Be aware that the vast majority of the information on the phpwiki outdated and incorrect.