#Documentation

6 Followers · 74 Posts

This tag relates to any discussions about InterSystems Data Platform documentation.

InterSystems Documentation

Article Yuri Marx · Jan 25, 2021 2m read

Hi Community,

In the past, technical documentation of the source code and software products was generated in chm, pdf files and documentation generators of the programming languages themselves. This old approach had the following limitations:
1. Outdated documentation;
2. Non-interactive and difficult to consult documentation;
3. Layout unresponsive, unfriendly and not adherent to HTML;
4. Inability to customize the layout of the documentation;
5. Inability to have HTML 5 documentation online and offline.
6. Lack of Markdown support.

5
0 725
Announcement Ksenia Samokhvalova · Mar 19, 2020

Hello Developer Community!

We are looking to better understand how our users use the Documentation. If you have a few minutes, please fill out this quick survey - https://www.surveymonkey.com/r/HK7F5P7!

Feedback from real users like you in invaluable to us and helps us create better product. Your feedback can go further than the survey - we would love to interview you about your experience, just indicate in the survey that you’re open to talking to us! 

Thank you so much! If you have any questions, please contact me at Ksenia.samokhvalova@intersystems.com

I look forward to hearing from you!

0
0 207
Question Joaquin Montero · Mar 2, 2020

Hi Everyone,

I've been working on deploying an IRIS for Health environment in EKS. There is a video session in the InterSystems learning portal about this feature but I have not succeeded in finding the proper documentation and resources to use this in my Kubernetes cluster.

Has this been deprecated/discontinued? Any idea where can I find the resources? Should I stick to StatefulSets instead of using the IrisCluster resource type provided by this operator?

3
1 463
Announcement Lexi Hayden · Oct 31, 2019

For IRIS 2019.1 and later, the documentation has a new look and feel. Check it out:

https://docs.intersystems.com/irislatest/csp/docbook/Doc.View.cls
 

The underlying changes include a new style sheet and a complete rewrite of the code we use to generate HTML.  (There is now an underlying API for retrieving content as JSON, as well as a large set of unit tests -- for those of you who like that kind of thing!)

We're adopting the same HTML generation code for various static HTML files also served up on docs.intersystems.

2
1 424
Article Константин Ерёмин · Sep 18, 2017 8m read

image

The InterSystems DBMS has a built-in technology for working with non-structured data called iKnow and a full-text search technology called iFind. We decided to take a dive into both and make something useful. As the result, we have DocSearch — a web application for searching in InterSystems documentation using iKnow and iFind.

18
0 1681
Question Kevin Furze · Nov 15, 2017

I'm looking for information, suggestions, video (courses) on make a lot more use of the documatic system already built into Cache,

Probably talked of before within this forum, but after an hour or two of searching, can't find the articles that I mmay have seen before.

I want to do a lot more documenting of my installation, we use and actively comment classes and methods, but I want to take it further by actually documenting the "why" and high level "how" my system works. Documatic seems a good place to put that knowledge.

6
0 576
Question Kevin Furze · Nov 13, 2017

A third party developer has asked for access to the documentation of my classes so he can understand my tables/classes better.

  • How do I give access the the documentation of my classes (single namespace)  and secondary, do I need to give  him access to %system. (and others)
  • Is it possible to block the likes of ensemble, Iknow, deepSee etc. I don't use those, and I don't want him to waste time (and my money) exploring areas that simply not necessary
  • what privilege roles do I need to give him  whilst still maintaing security.

kevin

4
0 457
Announcement Josh Lubarr · Oct 19, 2017

Hi, Community!

We are pleased to invite you to participate in the InterSystems Documentation Satisfaction survey. As part of ongoing efforts to make our content more usable and helpful, Learning Services wants your feedback about InterSystems documentation. The survey covers many different areas of documentation, and you can complete it in about five minutes. The deadline for responses is October 30. Also, responses are anonymous.                                                                                           

The survey is over, thanks!

1
0 433
Article Elizabeth Harding · Oct 10, 2016 3m read

At Global Summit back in April, in his keynote speech, John Paladino mentioned that improvements to our documentation search were being made.  You might have wondered, since things seemed to go quiet, whether anything was really happening.  Well, we had an internal demo of some of the upcoming features recently, and the new capabilities look really cool – searching documentation has been frustrating for InterSystems staff too!  So, I thought it might be good to pass on a few details to give a taste of what is coming.

4
0 580