Article Overview
Get started now: How to Add or manage Article user guide.
New 7.11 Want every Article to share the same structure? Follow the Consistent documentation journey.
The Article Overview, All Articles in the Repository Model menu, lists every Article in your knowledge base. Find the Article you need in seconds and read it, without asking a colleague where the runbook is.
- ✅ Find Articles fast with the filter box, Tags, and Custom Metadata
- ✅ Open an Article to read it, or download it as Markdown
- ✅ See at a glance how many revisions each Article has
Articles are a key feature of Nodinite. Read the Knowledgebase Articles page to understand the basic concepts.
The Article Overview: filters on top and one row per Article.
Find Articles
Narrow down even a long list of Articles with the filters above the list. They combine, so each one you add narrows the list further.
| Filter | What it does |
|---|---|
| Filter the result | Type characters to keep only the Articles whose title matches |
| Filter on Tag | Keep only the Articles with the Tags you pick |
| Hide shipped documents New 7.12 | Leave out the Articles shipped by Nodinite, such as the ready-made examples (see Shipped by Nodinite) |
| Generated by New 7.12 | Keep only the Articles written by a generator, such as BizTalk, or pick None for hand-written Articles (see Generate Articles from BizTalk) |
| Generation run New 7.12 | Keep only the Articles one generation run wrote |
| Include deleted | Also list deleted Articles |
| Custom Metadata filter | Click the filter button at the right of the filter bar to filter on the Custom Metadata of your Articles |
The Custom Metadata filter works the same way as on the other Repository lists: pick a field, enter one or more values, and add up to four rows. See Portfolio Filtering for how rows and values combine.
The Custom Metadata filter: select a field, enter one or more values, and optionally tick Exists or Invert condition.
Sort the list by Title, or by the Created and Changed dates, with the buttons under the Title header.
What each column shows
| Column | Shows |
|---|---|
| Title | The Article's title. Click it to open the Article for reading |
| Tags | The Tags on the Article |
| Content Type | Markdown or HTML |
| Last Changed By | The user who saved the Article last |
| Revisions New 7.12 | How many stored revisions the Article has; empty when it has none (see Revision History) |
Read an Article
Click the title of an Article, or choose View from its Action menu, to open it for reading; see Reading Articles for the reader toolbox. The Action menu also offers Compare…, Download (.md) and Download RAW (.md), and Show in Mapify and Show in Mermaid to see the Article and its relations in Mapify or as a Mermaid diagram.
The Action menu for one Article. The other items depend on your Role; Purge Revisions shows only when the Article has more than one revision.
If your Role lets you change Articles, choose Edit to open the Article in the editor; see Add or manage Article.
Search the Text of Articles
New 7.12 To find every Article that mentions a queue, a server, or a system name, click Search content in the list's toolbar, or press Ctrl+Shift+F. It searches the text of Articles and Snippets, and of Templates and Document Profiles when you tick them, lists each match with the line it's on, and opens an Article with the matches highlighted. See Content Search. To change a server or queue name in every Article at once, press Ctrl+Shift+H; see Replace Content.
Revisions
New 7.12
Every time an Article is saved, Nodinite stores a revision. The Revisions column shows how many each Article has. Open an Article in the editor to see its History card, where you can compare, restore, or clone from an earlier revision. See Revision History.
Compare two Articles
New 7.12 See how two Articles differ, side by side:
- Tick exactly two Articles and choose With Selected > Compare (2).
- Or choose Compare… in one Article's Action menu, and pick the other document.
The compare tool only reads, so nothing changes. See Compare Articles.
Download Article as Markdown
Download one Article as a single Markdown file. Choose Download (.md) or Download RAW (.md) in the Article's Action menu, or open the Article to read it and click Download in the toolbar, next to Edit and Print. Choose:
- Markdown (as shown) - the Article as you see it, with macros already replaced by their values.
- RAW markdown - the Article source as written. Macros, links, and other references stay as they are, so the content they point to isn't included.
Pick Markdown (as shown) to share what readers see, or RAW markdown to reuse the source.
Change or delete Articles
If your Role lets you change Articles, you can add, edit, delete, and restore them, and work with many at once with With Selected; only an administrator can permanently delete them. See Manage Articles for every step, including purging revisions and exporting Articles as a ZIP file.
Frequently asked questions / Troubleshooting
How do I create a new Article?
Read and follow the instructions in this user guide: Add or manage Article.
How do I create and use tags?
Tags help categorize and organize articles for easier discovery. In the "Tags" section, simply start typing letters to either find an existing Tag or create a new Tag; a suggestion marked Id: New creates a new one. Click the Save button to persist changes. To tag many Articles at once, use With Selected > Add Tag (see Bulk Actions).
Type to find an existing Tag or create a new one.
Why is an Article missing from the list?
Check the filters: Hide shipped documents hides the Articles shipped by Nodinite, deleted Articles are listed only when Include deleted is ticked, and Filter on Tag and the Custom Metadata filter keep only matching Articles. Ask someone who may change Articles to restore a deleted one.
How do I link shared files into an Article?
Use the Insert Files from the File Library section in Add or manage Article to insert reusable shared files and keep the same approved document, schema, or runbook in sync across multiple Articles. This is the same shared asset pattern described in the File Library.
How do I link an Article from a C4 Diagram node?
Use the C4 Article Links section in Repository Bindings to attach an Article to any bound C4 node. The article badge then appears on the diagram tile so viewers can open the guidance directly from the architecture view.
How do I add my Knowledgebase Articles to Resources for use in Monitor Views?
As a Nodinite Administrator, simply click the Action button for the Resource and select Articles
Click the Articles menu item to create new articles for the selected Resource.
Next, you need to define the scope for your article:
- Share articles with Applications - You can make 1 single article shared between all Resources belonging to one or more Applications
- Share articles with Categories - You can make 1 single article shared between all Resources belonging to one or more Categories
- Associate article with selected Resources - You can make 1 single article shared between selected Resources
Open a Resource in a Monitor View and choose Articles; Add Article on a card creates an Article linked at that level.
Next Steps
Add or manage Article
Manage Articles
Consistent documentation
Related Topics
Repository Model
Repository Overview
Bulk Actions
Revision History
Compare Articles
Content Search
Custom Metadata
File Library
Repository Bindings
Monitor Views