View Issue Details
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0016610||mantisbt||documentation||public||2013-11-12 18:22||2014-12-08 00:33|
|Priority||normal||Severity||feature||Reproducibility||have not tried|
|Target Version||1.3.0-beta.1||Fixed in Version||1.3.0-beta.1|
|Summary||0016610: Suggestion for Admin Guide: Vars' default values on new line|
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:
Specify the location for uploading attachments. This can be DISK, DATABASE,
What I suggest is something like this (the Values line is optional):
|Tags||No tags attached.|
Thanks for your suggestion for improvement.
Our documentation is stored in XML files . If you want to see these changes any time soon, I invite you to submit a pull request with your improvements :)
A pull request has been submitted with a GitHub user called cheesecracker.
Yes, that's the idea. I added some comments in your pull request 
I've seen that you've taken the changes. Yeah, just do whatever you like :)
For the other similar configs in the admin doc, I'll leave to for you :)
I'm not sure what you mean by that. I have done nothing except comment on your pull request, and it was you (or cheesecracker if that's another person), not me, who closed it.
With regards to the other configs, I have other and more urgent things to do to than to change them - as mentioned before, if you want this change I suggest you take the time to submit them yourself otherwise it is not going to happen.
Ah! I received all those comments, esp the message
OK, I'll open it again. I'm not used to Git. So do tell me when it's done.
FYI, I deleted that branch and created another branch.
The new pull request was not really necessary.
Anyway, I've merged the change in; feel free to submit additional changes for other config items.
Resolving the issue since Horinius is apparently not going to submit further updates to the documentation.
I have had many things to do in real life and my job. That's why I didn't submit anything further.
About the other branch: I was still in my learning curve in this GitHub, so I was a bit lost. I created another branch to make sure I didn't screw up things :)
Is it possible to break the file Configuration.xml into smaller files -- one for each chapter? The file has thousands of line and it always took me a while to get to the place I wanted to change. Anyway, it's always better to have smaller files because that would reduce the chance two people changing the same file at the same time.
Actually, I saw that "admin guide" itself is already divided into small files, so that must be possible, right?
Few days ago, I tried to compile the guide with Publican by following the README but failed. I used XP. Are you using Linux?
|2013-11-12 18:22||Horinius||New Issue|
|2013-11-14 06:03||dregad||Note Added: 0038550|
|2013-11-14 06:03||dregad||Status||new => feedback|
|2013-11-17 12:10||Horinius||Note Added: 0038572|
|2013-11-17 12:10||Horinius||Status||feedback => new|
|2013-11-17 15:58||dregad||Note Added: 0038574|
|2013-11-17 15:58||dregad||Status||new => feedback|
|2013-11-18 07:02||Horinius||Note Added: 0038579|
|2013-11-18 07:02||Horinius||Status||feedback => new|
|2013-11-18 09:03||dregad||Note Added: 0038582|
|2013-11-18 09:35||Horinius||Note Added: 0038583|
|2013-11-19 11:24||Horinius||Note Added: 0038594|
|2013-11-19 14:04||dregad||Changeset attached||=> MantisBT master 229a67df|
|2013-11-19 14:07||dregad||Note Added: 0038596|
|2013-11-19 14:07||dregad||Assigned To||=> dregad|
|2013-11-19 14:07||dregad||Status||new => feedback|
|2013-12-03 05:31||dregad||Note Added: 0038817|
|2013-12-03 05:31||dregad||Status||feedback => resolved|
|2013-12-03 05:31||dregad||Fixed in Version||=> 1.3.0-beta.1|
|2013-12-03 05:31||dregad||Resolution||open => fixed|
|2014-01-24 11:03||atrol||Target Version||=> 1.3.0-beta.1|
|2014-10-09 13:02||Horinius||Note Added: 0041489|
|2014-10-22 19:36||dregad||Relationship added||related to 0017781|
|2014-12-08 00:33||vboctor||Status||resolved => closed|