gerv / bugzilla-docs Goto Github PK
View Code? Open in Web Editor NEWFork of Bugzilla where I'm working on rewriting the docs
Fork of Bugzilla where I'm working on rewriting the docs
for large chunks of ASCII data
plaintext (or plain text)?
(I know this is old text but maybe fix now?)
First paragraph should technically read more like this:
Years of bug-writing experience has been distilled for your reading pleasure into the Bug Writing Guidelines. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs and isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
2.3. Todo: mod_perl on windows is still a bear.
2.3.1. Todo: No, my install is a 64bit perl. You just have to make sure everything else is 64bit
2.3.3. Todos: No, the module list is incomplete. It varies depending on perl version.
Yes, install-module.pl does not work on windows at the moment. (Weirdly, cpan works and even installs a C compiler!)
Section 7.1.8 is a bit confusing. If I understand correctly, WebDot is a web (CGI) version of GraphViz's "dot" program, and the latter does not require the former; this seems to be implied by the first webdotbase bullet. If so, this section should be cleaned up to somehow indicate that you can use a local GraphViz installation or a WebDot installation, since you don't need WebDot at all if you have local GraphViz (again, if I understand this properly).
Bugzilla queries are case-insensitive and accent-insensitive, when used with either MySQL or Oracle databases. When using Bugzilla with PostgreSQL, however, some queries are case-sensitive.
Bugzilla queries are case insensitive and accent insensitive when used with either MySQL or Oracle databases. When using Bugzilla with PostgreSQL, however, some queries are case sensitive.
The preferences are split into a number of tabs:
It's a bit weird to end on a colon here, since what follows are subsections with big headers, not an in-section list. Maybe something like
The preferences are split into a number of tabs, detailed in the sections below.
or something.
6.1.1. Ad-Hoc APIs
For the others, would it be worth mentioning the end points for each of the different API methods?
IMO, we could just leave out the mention of the BzAPI compatibility extension as this is documentation for upstream and may just cause extra confusion. People will just use the REST API anyway. Also I woild leave out the mention of REST v2 since documentation about a stable API should not need to mention about upcoming features or releases. That is for the release notes.
5.6.2. Adding New Fields To Other Things
5.6.3. Adding Admin Configuration Panels
Param('extension_param') %] or Bugzilla->params->{extension_param}.
5.6.6. Checking Syntax
"Bugzilla allows you to 'clone' an existing bug"
I think we should use double quotes here, as we appear to do elsewhere.
Section 7.3.3:
Login Name: This is generally the user's full email address. However, if you have are using the emailsuffix parameter, this may just be the user's login name. Note that users can now change their login names themselves (to any valid email address).
"can now" -> since what version? Has this ability been around long enough now to remove this note?
5.6.3. Adding New Fields To Bugs
I would mention the bug_end_of_update and bug_end_of_create for setting the new bug fields when a bug changes.
bug_end_of_create
, bug_end_of_create_validators
, and bug_end_of_update
the create or update the values for your new field.5.6.4. Adding New Fields To Other Things
object_end_of_create
, object_end_of_create_validators
, object_end_of_set_all
, and object_end_of_update
to create or update the values for the new object fields you have added... code-block:: perl
sub object_end_of_create {
my ($self, $args) = @_;
my $class = $args->{'class'};
my $object = $args->{'object'};
if ($class->isa('Bugzilla::Product') {
[...]
}
}
You will need to do this for most of the hooks starting with object_*
.
"These define exactly what state the bug is in - from ..."
First, I'd vastly prefer the use of proper em dashes (with no spaces, e.g. "... bug is in—from ...") everywhere (and I wouldn't be surprised if dash styles change throughout the document). Second, perhaps a colon is better suited here.
This applies to other sections below that follow the same pattern.
The theory58S mirror seems to be gone. It's been my experience that newer perls are much easier to work with on Windows, perhaps we could recommend 5.12 or newer?
sets of bugs over time.)
sets of bugs over time).
3.1 Overview
Should we capitalize the first words in the numeric list?
3.2.3
The 'TODO' should probably be removed. This is, to the best of my knowledge, the best way to pull stable.
3.4.1
On the 'TODO': if we want to avoid the task of updating to the latest point release, we'd probably want to get into detail on git tags, so they can compare against their current running version.
Misc. notes
Going to report issues here as I go through the OS X installation docs.
First, I think you can get gd support also through homebrew via "brew install gd". It would be nice to indicate how we can verify that Bugzilla has found gd, though.
Add comma: "Bugzilla uses cookies to remember you are logged in, so, unless ..."
5.5.1. Template Directory Structure
5.5.2. Choosing a Customization Method
5.5.3. How To Edit Templates
5.5.5. Particular Templates
[% USE Bugzilla %]
[% cgi = Bugzilla.cgi %]
User-Agent: [%+ cgi.user_agent() %]
Build Identifier: [%+ cgi.param("buildid") %]
For example, the text "http://www.bugzilla.org" will be turned into a link: http://www.bugzilla.org.
Either omit the last part or prevent the former from being linkified in the docs, as there's no difference between the two the way it's currently written.
Need to mention that if multiple languages are installed on the current system, a menu will display in the header allowing the user to manually select a different lanuage to display. This overrides the Accept-Language header.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.