4,400
edits
Volunteer: Difference between revisions
Jump to navigation
Jump to search
m
Robot: Cosmetic changes
m (→Artwork Creators/Contributors: new section: shader requests) |
m (Robot: Cosmetic changes) |
||
| Line 130: | Line 130: | ||
Currently, some of the other documentation that comes with FlightGear is lacking, terse or simply inaccurate (outdated) in various places due to the advances in FlightGear's code since the time when the original documentation was written. This state is not improved by people's tendency to create new documents instead of maintaining what already exists. | Currently, some of the other documentation that comes with FlightGear is lacking, terse or simply inaccurate (outdated) in various places due to the advances in FlightGear's code since the time when the original documentation was written. This state is not improved by people's tendency to create new documents instead of maintaining what already exists. | ||
As a documentation editor/reviewer, it would be your task to check the current documentation and identify areas for improvement. Preferably you should also be able to directly make corresponding suggestions for augmentations, or even write new help documents altogether (possibly based on evaluating recent mailing list discussions). You would be expected to thoroughly check the documentation folder ([[$ | As a documentation editor/reviewer, it would be your task to check the current documentation and identify areas for improvement. Preferably you should also be able to directly make corresponding suggestions for augmentations, or even write new help documents altogether (possibly based on evaluating recent mailing list discussions). You would be expected to thoroughly check the documentation folder ([[$FG ROOT]]/Docs) and review all relevant documentation for obvious shortcomings or mistakes, smaller corrections shall be sent by email to the developer mailing list, preferably in unified diff format (for patch to work). | ||
Alternatively, small text files can also be sent directly to the mailing list, more complex modifications should be only made available by uploading them to a webpage and linking to the corresponding files from your emails. If you are not now familiar with the process of creating unified diff patches, but would like to make it easier for the developers to work with your changes, please consider trying [http://kdiff3.sourceforge.net/ KDiff3], a GUI frontend to the diff and patch utilities that works on several platforms (also Windows). | Alternatively, small text files can also be sent directly to the mailing list, more complex modifications should be only made available by uploading them to a webpage and linking to the corresponding files from your emails. If you are not now familiar with the process of creating unified diff patches, but would like to make it easier for the developers to work with your changes, please consider trying [http://kdiff3.sourceforge.net/ KDiff3], a GUI frontend to the diff and patch utilities that works on several platforms (also Windows). | ||