The new docs.marklogic.com

by Evan Lenz

With the release of MarkLogic 6, we made some big changes to the Developer Community website. Chief among them is integration of the MarkLogic product documentation. This is something we've been working on for longer than I care to admit! But I'm very happy now that it's out there so you can take advantage of it. In this post, I'm going to briefly highlight some of the features, followed (in part 2) by a discussion of how it's all put together (if you're interested in that sort of thing—you should be if you're a developer, right?!)

To check this out (rather than just read about it), click the "Docs" link in the top nav bar, which takes you to http://docs.marklogic.com/. We had several goals for the new application, but chief among them were these:

  1. Use friendly URLs
  2. Enable users to comment on the API docs

On the friendly-URL front, we decided to make it as simple as possible to look up the documentation for a given XQuery/XSLT function. Given that we have over 2000 of these, we figured that would give us a good bang for our URL-space buck. If you want to see the documentation for the xdmp:document-insert() function, you just type its name: http://docs.marklogic.com/xdmp:document-insert. And even if you're too lazy to type the prefix, that's okay too; http://docs.marklogic.com/document-insert will take you where you want to go.

Once you're there, you might realize that you have a cool trick or caveat or question regarding this function. Where should you go to ask or share it? Look no further than scrolling down the page to type your comment or question. Although these are moderated, you'll see your comment appear soon enough (we try to respond as soon as we can and reply if necessary).

Previously, the various product user guides were only available in PDF form. They're still available in PDF form for those of you who would like to print them, but now each chapter is in its own HTML page. This makes it much easier to share knowledge, for example, when you're answering a question on the developer list or Stack Overflow. For example, rather than just link to the Application Developer's Guide, you can now drill down straight to the section you want to point out, say, the section discussing what directories are in MarkLogic.

No worries if you haven't yet upgraded to MarkLogic 6 (incidentally, what are you waiting for?)—you can choose what version of the server docs you want to view by clicking the appropriate link at the top left (above the TOC):

Machine generated alternative text: Server versIon: 4.1 I 4.2 I 5.0 I MarkLoglc 6

When you switch to, say 5.0, it will also affect your search results, so that any function, guide, or REST API docs that are returned will be specific to MarkLogic 5. Your preference is stored as a cookie, so if you want to go back to the latest docs (MarkLogic 6), then you would need to click "MarkLogic 6" again, either here or on the search results page.

There are other features too, like TOC filtering, admin help docs, sorting functions by category as well as by name, etc. In part 2 of this post, I'll delve a bit into the architecture of the app.

In the mean time, if you have any feedback, comments, questions, or suggestions about the new docs.marklogic.com, please feel free to leave a comment on this post.

Comments