Mercurial > hg > toolbox

comparison ABOUT.txt @ 0:b0942f44413f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
import from git://github.com/mozilla/toolbox.git
author Jeff Hammel <k0scist@gmail.com>
date Sun, 11 May 2014 09:15:35 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b0942f44413f
1 toolbox
2 =======
3
4 *an index of Mozilla software tools*
5
6
7 The Story of Toolbox
8 --------------------
9
10 Tools are only useful if you know where they exists and can find them.
11 Toolbox is an index of tools developed by and
12 for the Mozilla community. Toolbox is not a hosting service -- it is a
13 listing of tools which can live anywhere that are of use to Mozillians.
14
15 It can also be used to track:
16
17 * smart bookmarks
18 * code snippets
19 * webapps
20
21 Each tool in the listing must provide the following attributes:
22
23 * a *name* that uniquely identifies the tool
24 * a text *description* of the tool
25 * a canonical *URL* where you can find the tool
26
27 Toolbox also tracks several optional classifiers for each tool in its
28 database. The classifiers are described below.
29
30
31 How to use Toolbox
32 ------------------
33
34 The `index page <./>`_ of toolbox lists all tools with the most
35 recently updated first. All fields on a tool are clickable. Clicking on the
36 description lets you edit the description which will be saved after
37 you finish editing it. Hovering over the tool title or URL will display an
38 `edit button <http://universaleditbutton.org/>`_ which on clicking
39 will allow you to edit the appropriate data.
40 Clicking a URL, like `?author=harth <./?author=harth>`_ will give
41 you the tools that ``harth`` wrote. There is also full text search
42 using the ``?q=`` parameter (like `?q=firefox <./?q=firefox>`_ ) which
43 will search both the descriptions and all of the fields.
44
45 You can also display results by a particular field by going to that
46 field name. For example, to display tools by author, go to
47 `/author <author>`_ . You can add a new tool at
48 `/new <new>`_ by providing its name, description, and URL. Upon
49 creation, you'll be redirected to the tool's index page where you can
50 add whatever classifiers you want.
51
52
53 Classifiers
54 -----------
55
56 Outside of the required fields (name, description, and URL), a tool
57 has a number of classifier tags. These fields are:
58
59 * usage: what the tool is for
60 * type: is the tool a particular kind of software such as an addon or a script?
61 * language: which programming language the tool is written in
62 * author: who wrote and/or maintains the software?
63
64 You can freely add and remove classifiers for each project.
65 Autocomplete is enabled to help you find the classifier you want.
66
67
68 TODO
69 ----
70
71 There is much more that we plan to add to Toolbox. The project source
72 code may be found at https://github.com/mozilla/toolbox .
73
74 * add scrapers for hosted tools to automatically seed toolbox with data
75 * integrate author with community phonebook and bugzilla id
76 * the first time someone edits a description (etc.) from a pointed-to
77 file (e.g. a setup.py) then the project should be notified
78 * you should be able to edit a field, e.g. author. Changing one field
79 value should give the option to change all similar field values.
80 * a "Request a tool" link that functions like stack overflow; users
81 can request a tool. If it does not exist, it gets turned into a
82 bug. Users should also be able to point to a tool to answer the
83 question. Similarly, developers should be able to see a list of
84 requested tools and take ownership of them if desired
85 * Similarly, users should be able to note similarity of tools and
86 propose a consolidation strategy
87
88 Oustanding issues are listed at
89 https://bugzilla.mozilla.org/buglist.cgi?resolution=---&component=Toolbox&product=Webtools
90 . Please file new bugs or feature requests at
91 https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Toolbox
92 or contact jhammel@mozilla.org or discuss in #ateam at irc.mozilla.org.
93
94
95 Other Resources
96 ---------------
97
98 Mozilla tools are recorded on other sites too.
99
100 * http://www.mozdev.org/
101 * https://wiki.mozilla.org/User:Jprosevear/Tools
102 * http://infomonkey.cdleary.com/
103 * http://userscripts.org/