Description
Add a section called Reference as a sibling to User Guide. This can then contain the following children
- Pipeline Elements - Basically relocate this page https://gchq.github.io/stroom-docs/docs/user-guide/pipelines/element-reference/
- Document Types - One child page per doc type (.e.g feed, dictionary, index, etc.) with description of what they, what the settings are, what they are used by, anything else useful.
- XSLT functions - A migration of https://gchq.github.io/stroom-docs/docs/user-guide/pipelines/xslt/xslt-functions/
- Dashboard Expression Functions - Maybe one child page for function group (a migration of https://gchq.github.io/stroom-docs/docs/user-guide/dashboards/expressions/)
- Glossary - Relocate https://gchq.github.io/stroom-docs/docs/glossary/
- StroomQL Keywords - One page for all keywords with a anchor heading for each.
To make things easier to maintain, all the XSLT funcs need a java annotation that provides all the documentation for the function, including all the args (with types). This would follow a similar pattern to the stroom.dashboard.expression.v1.FunctionDef annotation and means the content can be largely/fully auto generated from code.
We could then have a short codes like pipe-elm (already got this), document, xslt-func and expr-func that would give you a link to the right place in the reference and some visual thing like the icon for the document or the pipe element lozenge. This means the content write doesn't have to worry about where the reference page is, just add something simple like {{< xslt-func "lookup >}} .