Automic Community

Expand all | Collapse all

Automic Documentation Site Issues

Michael Lowry02-28-2017 08:44 AM

Antoine_Sauteron_126602-28-2017 08:59 AM

  • 1.  Automic Documentation Site Issues

    Posted 02-10-2017 09:39 AM
    Hi everyone,
    The v12 has brought many changes in the documentation’s structure. You have already reported some of them either to the Support or to the Community. The purpose of this topic is to collect a list of issues related to the documentation in order to provide you with a follow up on their resolution. Below an example reported by Keld_Mollnitz

                                                                                                                                                                                   
    Issue #DescriptionStatus
    1A mix of English and French on this page:https://docs.automic.com/documentation/webhelp/english/AWA/12.0/DOCU/12.0/AWA Guides/help.htm#AWA/Overview/AWASysOverview.htm?TocPath=Pr%C3%A9sentation%20du%20produit|_____0Fixed
    2Documentation, Version 11.2 english > Topic for PREP_PROCESS_VAR is missingIn progress
    3Documentation switcher does not render nicely in iOS/AndroidFixed
    4DB Schema for v11.2 is not accessible (error 404) : https://docs.automic.com/documentation/webhelp/english/ALL/components/AE/11.2/DB%20Schema/db/_structure/HTML/index.htmFixed
    5The v12 API documentation is not available. (error 404) : https://docs.automic.com/documentation/webhelp/english/ALL/components/AE/12.0/API/index.htmlFixed
    6Version 11.2 of the AE documentation does not appear in the drop-down version listFixed
    7Version 11.2 of the AE documentation is not up to date (Version 11.2.2+build.388 )Already up to date
    8Search feature is broken in the V12 online documentationSolved after clearing browser cache
    9It would be nice if all AWA v12 documentation was in one placeEnhancement Request
    10Spelling errors in v12 documentationFixed


  • 2.  Automic Documentation Site Issues

    Posted 02-20-2017 02:52 AM
    The Documentation Switcher does not render nicely in iOS.
    0t8o8z3me9qk.pnghttps://us.v-cdn.net/5019921/uploads/editor/be/0t8o8z3me9qk.png" width="1334">


  • 3.  Automic Documentation Site Issues

    Posted 02-27-2017 05:17 AM
    Hi Michael_Lowry I tried under Android and saw the same issue.

    However I'm not certain the documentation website was intended to be accessed via a smartphone. Let me check with the documentation team and revert in this discussion thread.

    Best regards, Antoine


  • 4.  Automic Documentation Site Issues

    Posted 02-27-2017 07:02 AM
    Thanks, Antoine. For your information, the documentation site does not appear to display different layouts based on the HTTP user agent, and instead simply adapts to the window size or display size. For example, you can see the same behavior in Firefox on Windows, simply by shrinking the window to the size of a mobile phone screen.


  • 5.  Automic Documentation Site Issues



  • 6.  Automic Documentation Site Issues

    Posted 02-28-2017 08:44 AM
    The v12 API documentation is not available.


  • 7.  Automic Documentation Site Issues

    Posted 02-28-2017 08:59 AM
    [UPDATE]
    Thanks Michael_Lowry, this has just been fixed.



  • 8.  Automic Documentation Site Issues

    Posted 03-02-2017 04:36 AM
    Hi Michael,
    Our documentation team has reviewed issue #3 and here is their feedback:
    The documentation as it is now is not responsive. From a technical point of view, it would be very easy for us to switch to a responsive layout that adapts to virtually any mobile device. However, the content of the help does not really allow us to do it in a user-friendly way. The reason is that the help contains MANY guides in one.

    A responsive layout requires a landing page to provide the access points to the multiple guides in a clear, visible way.
    Whether having a responsive help is more important than providing a unique access point for all guides is something to be decided by PM. It would require a complete restructuring of the documentation and that would be a major issue.

    Please issue an enhancement request, as this is something that should be reviewed and decided by our Product Management team.

    Best regards,
    Antoine


  • 9.  Automic Documentation Site Issues

    Posted 03-03-2017 04:13 AM
    Issues #6 and #7 reported by FrankMuffke in this discussion have been added to the list.

    [Edit] :

    The online version of the documentation is the latest available.  Screenshot taken from versions.csv of image 'Automation.Engine_Image_11_2_17-02-27-1'

    4o2q7d704ukc.pnghttps://us.v-cdn.net/5019921/uploads/editor/f8/4o2q7d704ukc.png" width="567">

    Removing #7 from the list...


  • 10.  Automic Documentation Site Issues

    Posted 03-03-2017 10:05 AM
    Antoine Sauteron said:
    Hi Michael,
    Our documentation team has reviewed issue #3 and here is their feedback:
    The documentation as it is now is not responsive. From a technical point of view, it would be very easy for us to switch to a responsive layout that adapts to virtually any mobile device. However, the content of the help does not really allow us to do it in a user-friendly way. The reason is that the help contains MANY guides in one.

    A responsive layout requires a landing page to provide the access points to the multiple guides in a clear, visible way.
    Whether having a responsive help is more important than providing a unique access point for all guides is something to be decided by PM. It would require a complete restructuring of the documentation and that would be a major issue.

    Please issue an enhancement request, as this is something that should be reviewed and decided by our Product Management team.

    Best regards,
    Antoine
    Thanks, Antoine_Sauteron. I do not think it should be an either/or choice. If the plan is to insert the documentation switcher atop all documentation pages, then it should work regardless of the type of documentation being served, and regardless of the type of device or browser being used.


  • 11.  Automic Documentation Site Issues

    Posted 03-09-2017 04:18 AM

    Wolgang Bruekler

    : issue #6 is fixed. V11.2 is in the drop-down list again:
    0n5bl77lijko.pnghttps://us.v-cdn.net/5019921/uploads/editor/md/0n5bl77lijko.png" width="180">

    Michael_Lowry : I agree, but being able to display the documentation on mobile devices means that its layout must be re-arranged to avoid display issues.
    I know some tests are on their way, but we'd still like to have an enhancement request. Could you submit one, please?

    Best regards,
    Antoine


  • 12.  Automic Documentation Site Issues

    Posted 03-09-2017 05:38 AM

    I submitted this request to ideas.automic.com:

    Automic web sites should work well on mobile devices 

    When it is accepted for voting, you will be able to vote for it.



  • 13.  Automic Documentation Site Issues

    Posted 03-10-2017 04:09 PM
    Antoine_Sauteron

    The search feature in the V12 docu is broken again.  Would you be able to look into this?


  • 14.  Automic Documentation Site Issues

    Posted 03-13-2017 05:09 AM
    Hello Harriet_Kim_1764

    Thanks for reporting this. Issue #8 has been added to the list. I'll let you know once fixed.

    [UPDATE]

    This was a local issue. I faced the same behavior, but after clearing my browser cache the problem was solved. Could you confirm this?

    Best regards,
    Antoine


  • 15.  Automic Documentation Site Issues

    Posted 03-13-2017 01:48 PM
    Hi Antoine_Sauteron!

    Yes, clearing out my browser cache resolved the issue.  Sorry for the false alarm.  It's just odd this tends to happen with v12 docu and not with all the other docu versions (v11 and below).

    Anyway, thanks for looking into this! I appreciate your help. :)


  • 16.  Automic Documentation Site Issues

    Posted 03-17-2017 11:46 AM
    It sure would be nice if we could find all AWA v12 documentation in one place.
    597i1d2psb1z.pnghttps://us.v-cdn.net/5019921/uploads/editor/cb/597i1d2psb1z.png" width="308">


  • 17.  Automic Documentation Site Issues

    Posted 03-23-2017 07:04 AM
    Update about #3 : the documentation switcher now displays correctly on smartphones.

    in2fphz5mygu.png

    Michael A. Lowry

    : could you submit an enhancement request regarding your last entry ? I'm adding it to the table in the first post.

    Best regards,
    Antoine



  • 18.  Automic Documentation Site Issues



  • 19.  Automic Documentation Site Issues

    Posted 05-03-2017 04:08 AM
    There are currently many spelling issues in v12 documentation - for instance the 'q' is used instead of 'r' in every word. The issue has been raised internally. I will update this post as soon as it's been fixed.

    2ylvaimazm57.pnghttps://us.v-cdn.net/5019921/uploads/editor/qv/2ylvaimazm57.png" width="1600">

    [UPDATE]
    This has been fixed.



  • 20.  Automic Documentation Site Issues

    Posted 07-11-2017 05:42 AM
    The documentation switcher covers most of the display on iOS, and cannot be hidden.
    7gt17arr49t7.pnghttps://us.v-cdn.net/5019921/uploads/editor/8t/7gt17arr49t7.png" width="355">


  • 21.  Automic Documentation Site Issues

    Posted 12-07-2017 09:59 AM
    Would it be possible to fix the documentation search function so that it is not necessary to periodically clear the browser cache?

    Your search for ""str_cut"" returned 0 result(s). If you think this result is not accurate, clear your browser's cache and try again.



  • 22.  Automic Documentation Site Issues

    Posted 01-31-2018 04:11 AM
    The documentation is still unusable on small devices like iPhones. I reported this problem a year ago. Any chance this will be fixed?


  • 23.  Automic Documentation Site Issues

    Posted 01-31-2018 04:14 AM
    The documentation page now completely hides the table of contents sidebar and the search bar if the window width is narrower than 1280 pixels.

    1280 pixels wide

    2rih1smk7khe.pnghttps://us.v-cdn.net/5019921/uploads/editor/od/2rih1smk7khe.png" width="1280">

    1279 pixels wide

    80mz2pnxtmgy.pnghttps://us.v-cdn.net/5019921/uploads/editor/ka/80mz2pnxtmgy.png" width="1279">

    I like the idea of responsive design, but this is just broken. It’s clearly designed to hide unnecessary elements as the display area shrinks, but:
    • 1280 is probably too large a threshold for switching to the more compact view for mobile devices
    • It doesn't even work on small screens anyway. ;)


  • 24.  Automic Documentation Site Issues

    Posted 02-05-2018 10:34 AM
    The documentation is now entirely unusable on iPhone.
    m6hqq99c4pl7.jpeghttps://us.v-cdn.net/5019921/uploads/editor/ud/m6hqq99c4pl7.jpeg" width="558">