topic Re: Splunk Base documentation editor error [Object Object], links and images disappear, various random issues... in All Apps and Add-ons

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

guilmxm — Fri, 16 May 2014 08:38:24 GMT

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

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

MuS — Fri, 16 May 2014 09:25:36 GMT

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

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

guilmxm — Fri, 16 May 2014 09:42:34 GMT

Great, thanks!

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

MuS — Fri, 16 May 2014 10:03:23 GMT

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

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

guilmxm — Mon, 26 May 2014 17:30:44 GMT

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.