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

From SME Server
Jump to navigationJump to search
m
Line 1: Line 1:
==Chapter 1. Finding Answers===
+
==Chapter 1. Finding Answers==
 
Ideally most of the information you need to run and configure your server will be in the manual
 
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 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.  
 
If it's appropriate, you can add the material to the wiki, if unsure ask.  
  
===Manuals====
+
===Manuals===
[[/sme7/docs SME Manuals]]  
+
[[SME_Server:Documentation| Four Manuals]]  
Four Manuals are being written, for the User, Administrator, Technician and Developer.
+
are being written, for the User, Administrator, Technician and Developer.
  
====Bug Tracker====
+
===Bug Tracker===
 
Find, report and fix bugs here http://bugs.contribs.org/
 
Find, report and fix bugs here http://bugs.contribs.org/
  
Line 14: Line 14:
 
Bugs also include fixing things and making suggestions on documentation, translations and the SME Server web sites.
 
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 [[http://www.bugzilla.org/docs/tip/html/using.html Using Bugzilla]]
+
General Instructions for using the bug Tracker are here [http://www.bugzilla.org/docs/tip/html/using.html Using Bugzilla]
  
====Searching for bugs=====
+
'''Searching for bugs'''
To help find bugs, some prepared searches have been added in page headers, with more [[/howto/BugzillaReports BugzillaReports]] here
+
To help find bugs, some prepared searches have been added in page headers, with more [[SME_Server:Documentation:HowTo:BugzillaReports | BugzillaReports]] here
  
'''Simple search'''
+
1. Simple search <br />
At the top of the search page choose 'Find a specific bug'
+
At the top of the search page choose 'Find a specific bug' <br />
Select a Status and a Product category and enter your search term
+
Select a Status and a Product category and enter your search term <br />
  
'''Advanced search'''
+
2. Advanced search <br />
 
At the top of the search page choose '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  
+
You can restrict searches by using a selection or multiple selections of a category <br />
 
Use Control Click to select/deselect from selection sets, if none are selected all are.
 
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'
+
typically you may restrict Product to use  '7.x/Future/Documentation' <br />
 
and enter a search term into either 'Summary' or 'A Comment'
 
and enter a search term into either 'Summary' or 'A Comment'
  
eg. Status = CLOSED, Resolution = WONTFIX, Summary = yum
+
eg. Status = CLOSED, Resolution = WONTFIX, Summary = yum <br />
 
will return about 7 bugs
 
will return about 7 bugs
  
eg. Status = CLOSED, Resolution = WONTFIX, A Comment = yum
+
eg. Status = CLOSED, Resolution = WONTFIX, A Comment = yum <br />
 
will return about 17 bugs
 
will return about 17 bugs
  
Line 50: Line 50:
 
- If you have a favourite search,  
 
- 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
 
* 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
+
* add the search to the  [[SME_Server:Documentation:HowTo:BugzillaReports | BugzillaReports]] page
  
  
see [[http://smeserver.sourceforge.net/sme7/tech/Chapter5#h1127-3 Reporting and working on bugs]]
+
see [[SME_Server:Documentation:Technical_Manual:Chapter2#Bug_and_New_Feature_Verification | Chapter2 - Bug and New Feature Verification]]
  
  
Line 69: Line 69:
 
===How To's===
 
===How To's===
 
HowTo's are documents to solve a particular problem
 
HowTo's are documents to solve a particular problem
There is a list of [[SME_Server:Documentation:HowTo|HowTos here]]  
+
There is a list of [[SME_Server:Documentation:HowTo | HowTos here]]  
  
===F.A.Q.====
+
===F.A.Q.===
 
[[SME_Server:Documentation:FAQ|Frequently Asked Questions]]
 
[[SME_Server:Documentation:FAQ|Frequently Asked Questions]]
  

Revision as of 07:16, 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

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 BugzillaReports here

1. 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

2. 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,

  • when the bug list is displaying, add a name in the Remember field, these will show in your footer
  • add the search to the BugzillaReports page


see Chapter2 - Bug and New Feature Verification


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.