All Apps and Add-ons

Splunk Base documentation editor error [Object Object], links and images disappear, various random issues...

guilmxm
Influencer

Hi,

I have various issues with Splunk Base Documentation editor (markdown), for my App NMON Performance http://apps.splunk.com/app/1753/

It is very hard and complicated to maintain a good documentation within Splunk base with random issues and/or effects as:

  • Very often, href links simply disappear from the doc (writted in markdown)

  • Very often, some images links disappear, some other no (writted in markdown and images hosted in Splunk base)

  • Most of the time (i could not understand the factor why), i simply can't update the Documentation with an error message while trying to save "[Object Object]"

I've tried with both Chrome / Firefox with same behavior...

And i've tried everything when getting this message, and simple text lines were causing this issue but this seems to append very randomly !

I used to maintain the documentation code within the README file inside the App package, then when i needed to update the documentation in Splunk Base, i just had to copy/paste the code from the text file to the doc editor... i can get to understand why this does not work anymore

Is there any other good practice to get off this situation ? I also maintain the App documentation within the App (simple xml view with html), but it's pretty important for people to have access to it whitin Splunk Base while looking at the App page !

Thank you for you help

0 Karma
1 Solution

MuS
Legend

I suggest to get in contact with @oprokhorenko_splunk he is the Splunk base PM / Admin

View solution in original post

guilmxm
Influencer

For people reading this, the documentation in Splunk Base had an hard limit of 20.000 characters.
The description itself will have a limit of 1024 characters.

0 Karma

MuS
Legend

I suggest to get in contact with @oprokhorenko_splunk he is the Splunk base PM / Admin

MuS
Legend

you're welcome, please mark this as answered by ticking the tick 😉

0 Karma

guilmxm
Influencer

Great, thanks!

0 Karma
Get Updates on the Splunk Community!

Introducing Splunk Enterprise 9.2

WATCH HERE! Watch this Tech Talk to learn about the latest features and enhancements shipped in the new Splunk ...

Adoption of RUM and APM at Splunk

    Unleash the power of Splunk Observability   Watch Now In this can't miss Tech Talk! The Splunk Growth ...

Routing logs with Splunk OTel Collector for Kubernetes

The Splunk Distribution of the OpenTelemetry (OTel) Collector is a product that provides a way to ingest ...