User Tools

Site Tools


community:how_to_contribute

How to contribute

Translators

WebGUI

NAS4Free uses Launchpad for translating the WebGUI: http://translations.launchpad.net/nas4free/trunk/+pots/nas4free
We always welcome you to login and help translate NAS4Free's WEBGUI into your language. Help people around the world to use NAS4Free, please start translating today!

User Manual and Website

Documentation of any software project is a never ending task. We are always looking for knowledgeable volunteers to help keep the Setup and Users Guide up to date. If you have the time and are willing to help, we encourage you to review the Style Guide below and submit revisions, SUG sections or complete articles in .odt, .rtf or .txt format to any of the maintainers listed on the NAS4Free contributors page via e-mail ;-).

Style Guide

If you are going to contribute to NAS4Free's documentation please follow these suggestions:

Organization

  • Keep the Setup and User Guide (SUG) split by section headings into individual documents.
  • Section 2-Installation, Use & How To will contain all instructional and process related articles. This section will be expanded as necessary. Explanations or descriptions of WebGUI menus, options and settings should be kept to a minimum in this section.
  • Section 3 and higher will contain technical descriptions or explanations of options and settings in each WebGUI Menu and Tab. Sections will be added or removed as Menus and Tabs are added or removed to the WebGUI. No procedures or How To's should be included in these sections.
  • Where appropriate, links should be provided as necessary between procedural and technical sections.
  • All sections should include links to current HOW TO's and FAQs where appropriate.
  • All sections should include links to external sources, such as Wikipedia, where concepts or ideas need explanation. Do not assume everyone knows what NAT or RAID mean, provide links please.

Text Guidelines

  • Use DokuWiki headings properly so TOC's are automatically generated in pages where they are appropriate (if you are submitting .odt, .doc or .rtf files use Heading Styles 1, 2 and 3 as they will properly convert to DokuWiki). Each WebGUI page section should have an appropriate TOC heading and each option within a section should have a brief explanation of purpose or effect. Where appropriate links to further information should be provided. Please see 3.1-General System Options for a good example of a properly formatted page.
  • Use bold typeface for button and other control references, enclose them in quotes and capitalize the items' name, e.g., Click the “SAVE” button.
  • Use bold typeface for WebGUI titles, e.g., DNS Settings or IPv4 DNS servers.
  • Use industry standard abbreviations. Gigabyte and megabyte should be abbreviated GB and MB; gigabit and megabit, Gb and Mb. If you are not sure what to use, look it up please.
  • DokuWiki Note, Tip, Important and Warning code graphics do not print out. Preface all of these with text and a - indicating what they are, e.g.,
Tip - This is a tip.
When you print this the graphic will not appear so it is necessary to include the text, otherwise you would not know the importance of the information contained.

Image Gudelines

  • If you want to know how to create screen-shots or do not understand any of the requirements below, please read our Screen-shot Process Quick Guide.
  • If you take screen-shots on Windows (CIFS, iSCSI) please use Windows 7 or Vista.
  • If you take screen-shots on Linux (CIFS, NFS, iSCSI) please use Ubuntu (Debian OK), Fedora or Mandriva.
  • Prior to taking a screen-shot, resize the window to the smallest possible size that will fit all important information. This will produce the smallest and most legible image.
  • Images should be indexed, optimum palette of 256 colors max. and saved in .png format to create the smallest file possible.
  • All images should have a 1px black border.
  • Images should be a maximum of 700px wide and no bigger than 35Kb.
  • Where possible remove logos from screen-shots and only include the menu bars and important items contained in the body of the image.
  • Do not include any explanations or instructions in images since they will not be easily translated. All explanations and instructions should be part of the text.
  • Text descriptions or explanations of images should be made below or to the right of the image.

BSD user and/or PHP coder

We are not BSD gurus, only simple users. The NAS4Free code can be very easily improved and customized.

We are always looking for PHP expert(s) for reviewing/improving the NAS4Free code (95% of PHP, 5% of Unix shell).

Here is a simple way for ‘playing with NAS4Free’ from your MS windows PC:

1. Enable service SSH with ‘Permit root access’ checked.

2. Open an WinSCP (http://winscp.net) (or other SCP tools) session on your NAS4Free.

You can now directly edit the code files of NAS4Free:

  • /var/etc directory contains the configuration files generated (simple text config files)
  • /usr/local/www contains the WebGUI files (PHP files)
  • /etc/ contains the system scripts( PHP and Shell scripts)

Check existing files for learning how NAS4Free works (it’s very simple!)

3. Send your modifications on the NAS4Free developers mailing-list or send it by email to one of the developers.

Don’t forget to update the licence page if you are re-using other Open source code!

For installing FreeBSD under QEMU, there is the HOWTO : Installing FreeBSD 9.0 under QEMU for compiling NAS4Free.

Then you can build a NAS4Free from scratch, by following the : How to build NAS4Free from Scratch.

community/how_to_contribute.txt · Last modified: 2017/03/09 06:34 by hailthemelody