Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I am brand new to Pentaho and have the task of trying to integrate it into some Java applications I have been working on. So far my experience with Pentaho includes downloading the community BI-Server and setting up a couple of things in the admin console (new users/datasources). I was able to get access to the datasource in my PUC as well for reports and analysis.
Now I am trying to do practically the same thing in Java (Add a new datasource and configure it). I have been looking for different Java APIs and I must admit it is quite overwhelming with all the different APIs that are available (BI Platform, Kettle, Mondrian, Weka, Reporting). I decided to go with the BI Platform as this is the one that seems like it will fit this need. However the javadocs that are provided here seem to be out of date. I have imported the 4.8.0 dependency into my Java project via Maven and it seems I do not have some of the classes that are specified in the javadocs. Pentaho's APIs will probably begin to make more sense the more I dig into them, but as an overwhelmed n00b I need help in the following three ways.
1) Is pentaho-bi-platform-api the correct API to connect to and administer datasources?
2) Are there any useful java examples of the API that I could look at? (havent been able to find much on Google)
3) Does anyone know if these javadocs are out of date and if so are there any more recent versions?
Thanks a bunch
Many of the Pentaho projects have been moved to GitHub:
https://github.com/pentaho
This includes the data-access plugin, which handles the creation and configuration of datasources. The 4.8 branch is here:
https://github.com/pentaho/data-access/tree/4.8
And the latest 4.8 release tag (4.8.1-GA) is here:
https://github.com/pentaho/data-access/tree/4.8.1-GA
So I found out a good place to get examples. If you go to http://community.pentaho.com/getthecode/ you can find all the SVN repositories for the projects. After pulling in the projects from SVN do an ANT build on the build.xml using the resolve function. After that I was able to look at all the Unit tests that are included in the project and figure out how everything works.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
My team and I are currently building multiple services in parallel. We have the benefit of building all the services from scratch. I would like the ability to automatically display all API endpoints, from all services, in one page/site. This would be helpful because (among other things):
I don't have to go to multiple documentation sites to see what are the available endpoints in my entire "system".
It'll be a good first step to determine if any of the services should be split, combined or simply refactored.
Some of our services are in Django and the rest-swagger module is a great help. But I don't see how I can combine rest-swagger documentation from multiple services into a single documentation page/site.
I'm currently looking through this site and anything related to the Netflix experience but could not find a solution to my problem. Maybe centralized documentation isn't a big deal with 600+ services at Netflix, but that's hard to believe.
Can anyone suggest a tool or method to have a combined API documentation for all services in a microservice architecture?
My ideal scenario of what happens when a service is changed:
I click on the link to see the list of endpoints in my system.
A teammate updates a service and also it's documentation.
I refresh the page I am currently and I see that change made from step #2.
With my exp, you have some paths.
http://readme.io/
Make a wiki with JIRA, Redmine.
In Github create a repo for exclusive docs.
Google Docs.
I don't know about any existing tool rather I'm just putting my thought on where to do it.
From what the OP describe, they are already building a micro services architecture using Netflix stack. There should be a repository to config the name (or URL) for each of the services and the 'config server' or 'service registry' will read from that. To me, that's the perfect place to put the reference to each of the micro-service's documentation under their own entries. This way you get the benefit of maintaining the documentation and code at same place, plus you could potentially also collect run time information like instance/connections count if you hook into the config/registry server.
Being in similar situation I am looking to adopt https://readthedocs.org/ with GIT backed.
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
Can anyone give advice, or point to any guides, on how to manage a community of open source software developers in writing api documentation?
A typical, unmanaged, starting point for most projects is to have a project wiki where anyone can freely create pages, add content to existing pages, edit existing content etc. The problem is that, despite people's best intentions, the wiki can easily end up being a disorganised, poorly written, incomplete, written in disparate voices etc etc.
So, what to do to improve the quality of the documentation?
I suspect a key ingredient is clear editorial/style guidelines, something similar to http://en.wikipedia.org/wiki/Wikipedia:Encyclopedic_style#Information_style_and_tone. Can anyone point to an example of such a guide tailored specifically to software apis?
Are there any other practices that people have found useful? E.g. form a core team of editors and accept that most documentation that gets added by the community will most likely need to be 'strongly edited'?
The short answer, that the solution is social/human and not technical. The way to get good documentation for any project is to have someone with time, in charge of doing high level organization for the documentation, and then being involved in the development and user communities to ensure that the documentation remains up to date and continues to address the problems and confusions that users typically have.
Community projects have accepted that you need point people (i.e. "managers," for aspects of the project like "translation," and "release," and for various components. The same thing needs to happen for documentation.
As for tools, Sphinx is really great though it's not "wiki like," exactly you can use whatever version control system your project is comfortable with to store documentation and configure your web server to rebuild the documentation following commits/updates/pushes. Which has always worked just fine for any project I've worked on/with.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
What tools are available for record and play back type testing of an Eclipse RCP application?
I'm hoping for something that the end users will be able to pick up pretty easily and record their user acceptance tests with.
Have a look at this:
http://code.google.com/p/robotframework-eclipselibrary/
Robot framework is one of the easier testing tools for end users to pick up as it nicely separates code from tests.
WindowTester supports testing of SWT and Swing applications. It supports recording actions to Java tests. It was developed by Instantiations, which consistently delivered excellent products for Java development, integrated well within the Eclipse IDE. Google acquired Instantiations this year, and now offers WindowTester as free software.
Squish, by FrogLogic, supports many UI toolkits, including SWT. I toyed with the Qt version a few years back, and liked it. Squish supports recording to scripts that you can then edit, in Python, JavaScript, Perl or Tcl. Scripts are not dependent on screen coordinates. On the downside, Squish is exorbitantly priced, and it's licensed per UI platform.
Some other options are described in this previous question.
A comparision which includes most of the tools mentioned in the other answers (WindowTester, Squish, RCPTT, Jubula) can be found directly on the Eclipse website.
This question is quiet old and the answers outdated. RCPTT is a great if not the best solution to this problem. Free of charge and you are able to record user interactions
Eclipse foundation now has Jubula ptojext. See http://eclipse.org/jubula/ "Jubula"
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
This weekend I installed Windows 7 (brilliant!) and there I found this genious tool called Problem Steps Recorder. Apparently a tool that came with the beta bug reporting tool thingy.
I am currently trying to document some application usages for other developers. (In this exact case, how to get Showplan XML Statistics in SQL Profiler and some basic usage of Database Engine Tuning Advisor). And I was thinking that a tool like that Problem Steps Recorder with be perfect for this! Only problem is that it is only in windows 7 (?) and the output is an mht file which also contains some general bug issue text etc...
Anyways, does anyone know if this tool is available in a more general version? Or if there are some free and smooth alternatives which does kind of the same thing for Vista (and other windows versions if possible)?
Maybe Wink is your answer.
I'm looking for a better capture tool for both user documentation and reporting bugs. The best "steps recorder" that I've seen is bundled with Testuff. Their Test Runner app lets you select a region to record (video). It captures every mouse click and logs every key press along side the video playback. Of course, it's designed only for reporting bugs to a development team.
I'm still using SnagIt (cheap, not free) for capturing screens and adding annotations. I also have Camtasia, but that's definitely not "free" as you requested :)
I just stumbled upon 'Imago recorder', available via various software / download sites. It's not pretty but it does the trick and it's free.
It's currentyl available here
Additional option you should definitely pay attention to is StepsToReproduce. There are several options for recording (screen/window/region) and nice powerful annotation tools. And it's also free!
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I have inherited over 600 files of ColdFusion source code running a internal web site for my company. One of my tasks is to "document" it. The code base represents about 5 years of development and there is no technical specification of what it does.
The developers have maintained a change log of each file and there is a consistent header.
My thought is that I can build a dependency map of the various modules and referenced stored procedures to facilitate this documentation by scanning the source files. I have used Doxygen in the past for c++ source code and am wondering if a tool like this exists for ColdFusion.
One output I am investigating is the ability to create a xmind file as means of visualizing the cross dependencies in module inter-relationships.
Thanks in advance,
Chris
The ColdFusion server has built in introspection that outputs javadoc like documentation for any CFC class.
See: http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm
However, it requires an RDS login/password for your server. For delivery to third parties, I set up a recursive script that does a cfhttp fetch against the docs for each cfc file, and then compiles the pages to PDF with cfdocument.
You could start with ColdDoc
Also, heres a UML 2 CFC generator.
I guess what you really need is something to reverse engineer the coldfusion code into uml class diagrams. I don't know of anything off the top of my head.
MagicDraw, Objecteering don't seem to do it yet.
After trying to find an answer to this question myself I ended up writing this solution:
ColdDuck
Maybe it is too late for you now but I am just spreading the word.
Murray
Sounds to me like creating your own Xmind or XMI file is the way to go. The XMI file may be more portable between tools, but the last time I looked at doing that the XMI file formats were a bit daunting for the time I had available to work on the solution. If the formatting of the headers consistent is enough to read with ReFind or Find I'd build a script that uses cfdirectory and cffile to walk the code tree and output the file(s).