First Steps With Studio: Technical Documentation Tutorial

Updated: July 18, 2017 Page Information Edit on GitHub

This tutorial offers a progressive and educative tour of what you can do to customize the Nuxeo Platform with Nuxeo Studio. It could be one of the first tutorials you do.

In this sample use case, we will use the Nuxeo Platform to manage technical documentation. It will be important to make it easy to differentiate draft documentation items from validated ones. We will implement the publishing logic using the Nuxeo Platform.

Here are a few rules we want to follow:

  • A technical documentation document is called a "documentation item". Documentation items can be procedures, notices or installation instructions.
  • A documentation item is composed of an office file and a set of descriptive metadata.
  • When looking at a documentation item we should only display needed information, nothing else.
  • All documentation items should be stored in one place. This means it should be easy to filter documents by properties.
  • The document listing should display the useful metadata immediately.
  • A workflow should be available to validate a document easily.
  • A newly created documentation item should be editable only by its creator until the validation workflow is started.
  • Publishing should be automatic at the end of the validation workflow.

This how-to is divided in the following main steps:

a month ago manonlumeau Add note on pages used by marketing
7 months ago GitHub Fix capital letter
7 months ago Fred Vadon lts2016-review update technical documentation tuto
9 months ago Andrew Goodricke Add content-review-lts2016 to labels
9 months ago Kevin Leturc NXP-19481: Update MarkLogic page to detail how to configure range element indexes
a year ago Manon Lumeau 10 | emove children display macr
2 years ago Solen Guitter 9
3 years ago Solen Guitter 8
3 years ago Alain Escaffre 7
3 years ago Alain Escaffre 6
3 years ago Alain Escaffre 5
3 years ago Alain Escaffre 4
3 years ago Alain Escaffre 3
3 years ago Alain Escaffre 2
3 years ago Alain Escaffre 1
History: Created by Alain Escaffre