Suggestion for Admin Guide: Vars’ default values on new line

[Horinius]

For the administrator guide document, I have a little suggestion here which could improve the doc quality even more. My suggestion is to write variables’ default values on a new line/paragraph. The idea is to make it easier to spot these default values, so one can see if he needs to change the variable value or not.

Take $g_file_upload_method as an example. Currently, it’s written like this where the default value is buried inside the whole paragrph:

$g_file_upload_method

• Specify the location for uploading attachments. This can be DISK, DATABASE, or FTP. In case of FTP, the files are saved on the webserver (same as disk) as well as on the specified FTP server. Default value is DATABASE. In case of DISK / FTP upload methods you need to provide the webserver with write access rights to the configured upload path (configured in the project) and temporary upload path (used by PHP).

What I suggest is something like this (the Values line is optional):

$g_file_upload_method

• Values: DISK, DATABASE, FTP
  
  Specify the location for uploading attachments. In case of FTP, the files are saved on the webserver (same as disk) as well as on the specified FTP server. In case of DISK / FTP upload methods you need to provide the webserver with write access rights to the configured upload path (configured in the project) and temporary upload path (used by PHP).
  
  Default: DATABASE

[atrol]

You can enter a new issue at http://www.mantisbt.org/bugs with category "documentation" and severity "Feature"

Submitting a patch is always a good idea, as it increases the chances of improvement eventually making it into MantisBT core.
All contributions are welcome and greatly appreciated.

Patch submissions can be made in several ways. In the order of preference:

1. Send us a Pull Request on our Github repository [1]
2. Attach a GIT patch to the issue
3. Attach a Unified Diff, clearly specifying the patch's base release

Kindly avoid to upload entire modified files.

[1] https://github.com/mantisbt/mantisbt

[Horinius]

Here you are for the issue: http://www.mantisbt.org/bugs/view.php?id=16610

About patch, you mean documentation patch or program patch? But my suggestion is a change of style. So you might want to consider it first, and apply it all at once to keep a consistent style if accepted, no?

[atrol]

About patch, you mean documentation patch or program patch?

There is no difference.
More disucssion if needed at http://www.mantisbt.org/bugs/view.php?id=16610#c38550

[Horinius]

I'm not very into Git. Even less for GitHub. I'm more on SVN and Mercurial.

What do you mean by "pull request"? That means clone? Submitting a pull request is all I need to do? Or you expect me to change the XML file?

Sorry for the questions.

[atrol]

What do you mean by "pull request"?

https://help.github.com/articles/using-pull-requests

Submitting a pull request is all I need to do? Or you expect me to change the XML file?

There can't be a pull request without having changed anything.
I don't expect anything from you. This is open source and MantisBT lives from contributions of volunteers. There is no company behind it, no one is payed for the development.
http://www.mantisbt.org/wiki/doku.php/m ... ntributing