When connecting a BI source to Rupert, we will automatically generated documentation for each of the assets. The documentation contains info coming from the source and can be edited.
In this article we are going to cover the following topics:
Where is the asset's documentation located
To preview an asset's documentation, click on the asset in the "Assets" tab and head over to its "Documentation" section.
Under the Documentation you'll find:
Edit mode - An editor where you can add, edit and delete data blocks
ℹ️ Only available if you're the asset's owner or a Manager userSlack preview - simulates how the documentation will look like via Rupert's Slack app
What does the documentation contain
Rupert generates the documentation according to information coming from the source along with information from the Rupert Desk.
The documentation contains blocks of data and metadata coming from the source.
Metadata blocks which include:
Asset name
Asset description
Asset creator
Total number of views
Data block coming from the source and include:
Data sources
Charts names
Filter names
Filter values
How to edit the documentation
Double click a data block OR hover over it and click the "Click to tune" button to open the edit language popup.
Delete blocks
Metadata coming from the source / Rupert, can only be able deleted. To delete click on the 'X' icon.
Edit data blocks
Double click the data block change the language.
Alternatively, click on the pen icon to open the pop up.
Change language popup
Here you can modify the Rupert language (e.g., the raw data Rupert indexed from your source).
There are 2 options to edit a specific line in a block:
Hide the row by selecting the "Hidden" option from the dropdown
2. Change the text, by typing the new text under the "Your language" column and selecting "Your language" option from the dropdown
❗ Important - if you hide or change the language of one of the rows, say you change a filter name, if that filter name changes in the source, it will not be reflected in the documentation.
This can always be reversed by changing back the dropdown to "Rupert language"
Add new blocks (data or text)
To manually add data blocks to the documentation hover over one of the blocks and click the "Add new block" button.
** This will add the block under the hovered line.
In the new added line, you can either add free text or choose one of the metadata / data blocks.
Click "Tab" to open the menu and select a block or style your text.
To move your added block, hover over it and click the "Click to tune" button. Use the arrows to move the block up / down.
