Community
Participate
Working Groups
Almost all professional software projects have an FAQ section and I don't think TPTP should be an exception. An FAQ section can have many advantages and can save both the developer as well as the user's time by preventing the same questions being posted by multiple people on the newsgroup.
Navid, FYI TPTP does have a FAQ with some technical information in it: http://eclipse.org/tptp/groups/Marketing/pressroom/prfaq.html If you know of any questions and answers that should go into the FAQ, can you add a link to the post(s) here, please? That'll help both gather requirements for what should go into the FAQ and (hopefully) the answer will be part of the thread. And where did you look for the FAQ? The "Documentation" link off of the main page or somewhere else?
Ruth, I'm not sure where the location of the link you've posted is on the site! I wasn't able to find it. Usually the FAQ page would be accessible on the main page of the project. That's how I've seen it for most of the projects. Here are a couple of samples: - Xerces: http://xml.apache.org/xerces2-j/ - EMF: http://www.eclipse.org/emf/ These sites make all of their main links available on any page through frames/tables.
The link to the FAQ is sort of hidden, and not geared toward developer use. From the home page, click Press Room. The link is near the bottom of the Press Room Page. The FAQ could also use some updating, and a technical section with questions asked by people on the forum. A more constructive way of writing this defect, Navid, would be to specify questions you know are frequently asked, along with their answers, for inclusion in the FAQ. Then the bug could be addressed in a more reasonable timeframe. Once some useful things like that are added, then I think a link on the front page would be warranted.
Kari, I obviously don't have all the commonly asked questions. Some investigation is required to determine what should be included on the FAQ page. The best places to look for the most frequently technical questions are in the newsgroup and the mailing list archives. Everyone on the team should also be emailed and asked what the most commonly asked questions are for their component(s). FAQ pages usually contain general questions about the project (e.g. what is TPTP?...) and then the common technical questions. I'd like to see the following question on the FAQ page: - Q: How to prevent the JVM from crashing when profiling? A: Try disabling JIT when profiling your applications. - Q: How to disable JIT? A: Include the following VM Argument when profiling your application: -Djava.compiler=none - Q: Why is the Agent Controller necessary when profiling applications? A: The Agent Controller is used for managing all the different types of agents. You could be profiling two applications at the same time and so you'd have 2 profiling agents being managed by the Agent Controller. There are also other types of agents that can be implemented (e.g. logging agents). The Agent Controller is what sits between a client and an agent. There's no direct communication between an agent and the client. All communications are done through commands via the Agent Controller. This architecture allows us to communicate with agents on remote machines. You can, for example, use your computer to profile a Java application on a different machine.
BTW, what's the FAQ page doing on the Press Room Page?!
Thanks for some content. No one knows all the FAQs (heh); that's the beauty of collaboration. The fact that investigation is required, as you point out, is exactly why this is an enh not a bug. I suspect it's in the press room because it's a marketing FAQ not a technical FAQ.
Moving out to the future because this isn't committed in the TPTP 4.1 plan.
Was not committed to the TPTP 4.2 plan due to insufficient resources. Targeting to "future" for consideration in a future TPTP plan.
Changing this to "normal" rather than "enhancement" because no investigation will be done for this bugzilla. Rather, TPTP committers will be encouraged to add entries to the faq.xml files like they do for the release notes. (i.e., the FAQ is now self serve.) I've updated the doc on how to add a release note or migration entry to include instructions on adding a FAQ entry. Now I need to figure out how to invoke Javascript from a Phoenix PHP file...
I had coded the page correctly and didn't realize it. Nothing was showing up on the page because there were no entries in the faq.xml files. As soon as I added some temporary entries everything showed up as it was supposed to. Marking as FIXED. Note that this FAQ page will not go live until the TPTP Phoenix web site goes live. You can browse to the FAQ page via the TPTP Phoenix home page: http://www.eclipse.org/tptp/newindex.php
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant enhancements/defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this enhancement/defect is verified/closed by the Project Lead since this enhancement/defect has been resolved and unverified for more than 1 year and considered to be fixed. If this enhancement/defect is still unresolved and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.
