I'd like to put documentation on a confluence wiki for a project I'm working on, and I want to automatically generate some of the documentation from javadocs. Is there a plugin for confluence that makes this easy (did not see in preliminary search), alternatively has anyone written scripts to post wiki pages to confluence based on javadocs? An ant task might be cool, then I could have the wiki as a target.
Confluence JavaDocs Macros is a plugin that will generate wiki pages from javadocs. The downside is that a zip archive must be made of the javadocs and placed on the first page of a space, and multiple javadocs cannot co-exist in the same space.
The plugin is also not compatible with every version of Confluence.
And you might want to add javadocs to confluence if you only had a confluence server (or the confluence server is the primary place for documentation) to host your documentation... It has happened before.
Why would you upload javadoc into an editing system? This sounds rater odd. We created a apache server on which the project documentation is uploaded (which is created form Java as javadoc, and from some project documentation (which we also store in the project (inside SCM)).
Next to that we have a Wiki system, in which everyone can write all kind of stuff. It is easy in most wiki to make a external reference (to the Apache web-server, project documentation / javadoc pages).
The good thing about this is, that the project documentation can be re-generated through ant / maven / etc. and automaticly uploaded to some web-server. There is can only be red and not modified. That can only be done through the project sources. Which is good, because otherwise people start to edit the wiki pages, which then get replaced now and then, because a new build / release is created.
You can use the Docs Plugin: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin. This plugin enables you to upload and publish your JavaDocs and other HTML and JavaScript based content in Confluence.
Docs provides also a REST Interface in order to automate the publishing process. So, publishing the JavaDocs can become part of the Continuous Integartion Process. A technical documentation as well as a sample code can you find here: https://ricebean.net/confluence-docs
Related
I am working on a project that, among other things, automatically generates Swagger APIs for Python projects. One thing that I have noticed is that the curl text exposes passwords if the API requires those. Since there's no way to mask the passwords as of now (https://github.com/swagger-api/swagger-ui/issues/5025), it seems like the easiest thing to do is to simply disable the curl text so that I can screenshare my Swagger API without exposing my password.
In another issue (https://github.com/swagger-api/swagger-ui/issues/5020), a plugin is shown that can disable the curl text.
However, I'm totally stumped on how to actually import and use this plugin. There's lots of documentation about how to write plugins, and none on how to import them. I can see that I can load plugins using the plugins option in https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/, but I don't know how where to put the code.
As Helen alludes to, the answer to your question depends on your setup. However, I would hazard to guess that you will need to configure the SwaggerUI object by running an "unbundled" version of the app. You might think of this as creating a custom entrypoint to a docker container, say.
For example, the link you provide shows suggestions for running a customised version of SwaggerUI. Those customisations are written in JavaScript, so any old HTML page with the necessary dependencies in place which loads the script you write to configure SwaggerUI would answer the question of "where to put that code".
The details would depend on any frameworks you are or are not using.
I would like to take all project documentation at the confluence to GitLab-Wiki.
Is there any way to export from confluence to the GitLab 13ce wiki?
You can export all or parts of you Confluence to PDF (possibly other formats like MS Word?). That may suffice if your Confluence instance is small.
Alternatively Confluence provides a rich RESTful API with which you could iterate your Spaces and Pages, extract all needed details and then format/write them appropriate to GitLab-Wiki (which I don't know anything about). This is non-trivial but I've done something similar using PowerShell and the Confluence APIs.
I have started Sitecore learning few months ago.That time first question come in my mind is that how can I develop module? but can not able to find documentation. Can anybody provide me documentation how can I develop custom module?
If you mean you would like to create a module for the Sitecore marketplace, as others have done, then the process is fairly simple.
Write your code (ASCX, ASPX, CS, JS, etc.)
Create your Sitecore items (Layouts, renderings/sublayouts, custom buttons, etc.)
Create your configuration files (if necessary) for the App_Config\Include folder.
Build your solution and test it in a Sitecore instance locally.
Package the published files and item together using the Sitecore packaging utility.
Contribute your module on the marketplace and upload the package for review.
What you are hoping to achieve here is that another person could grab your package, install it on their system, and be able to use it without needing to recompile your source code.
If you want to develop a module, come up with the idea and then build it.
You can then submit it to the Sitecore a Marketplace under the contribute section.
https://marketplace.sitecore.net/Contribute.aspx?sc_lang=en
Typically you'll submit a package to this section and documentation on how to setup and use the module.
Sitecore will then test the module and inform you whether it is suitable for the marketplace. Your module will then be published on the marketplace ready for others to download.
When developing your module you should consider compatibility with Sitecore versions, and you should also test it thoroughly.
Here's some more info on best practices when building modules:
https://kb.sitecore.net/articles/831724
I want to integrate the Doctrine 2 to an Apigility driven Zend Framework 2 application.
So I installed zfcampus/zf-apigility-doctrine
$ composer require zfcampus/zf-apigility-doctrine "~0.3"
and activated the modules Phpro\DoctrineHydrationModule, ZF\Apigility\Doctrine\Server, and ZF\Apigility\Doctrine\Admin in the application config files (/config/application.config.php and /config/development.config.php).
What should be done next to start using Doctrine in the application as general and particularly in the Apigility Admin area?
I experimented with this Apigility extension in the fall but it was far from complete at that point. The server code was usable but there wasn't any UI integration to speak of. You can still manipulate endpoints by dissecting how zf-apigility-doctrine's controllers work and the information provided in the README. The rest is mostly trial and error. At the time I used the Postman plugin for Chrome to send requests to the endpoints mentioned in the README, trying different inputs until I found something that worked. It looks like they've made good progress on this portion of the integration since I last tried but I haven't revisited since to try again.
It seems there's no official integration with the Apigility admin UI yet. There is a repository for it (https://github.com/zfcampus/zf-apigility-admin-ui) but a quick browse of the open tickets shows it's not working yet. Someone has forked it and worked on it, but I haven't looked into it myself so I can't comment on it's readiness.
My suggestion is that if you want to learn how to integrate zf-apigility-doctrine into your Apigility the best way to do that right now is to take a look at Roll'n API (source here)
Does anyone know if there is a help authoring tool out there that can produce help documentation for a software product that looks like a wiki? We are currently using the Confluence wiki engine, which is absolutely brilliant and we were wondering if there is anything like that but without the need for an Apache server. Something stand-alone that can give our users the help documentation they need. We have used help authoring tools and they all seem so clunky compared to a wiki.
Use Wiki on a Stick.
Its a single .html file written in Javascript/html and saves the changes onto itself.
You don't even need Apache. Awesome tool!
How about Juli? It generates static HTML so you can browse documents by browser only.
It is used for:
Juli documentation itself.
Edgar project documentation (another my OSS project).
My personal wiki/blog. I'll show later since new users can only post two links(stackoverflow limitation)