Automic Workload Automation

 View Only

  • 1.  Documentation redirects not working. Anchor targets removed.

    Posted 25 days ago
    Edited by Michael A. Lowry 25 days ago

    Broadcom has now completed the migration of Automic documentation from docs.automic.com to techdocs.broadcom.com.

    Links to the documentation of specific REST API endpoints are now completely broken in two ways.

    1. Deep links to documentation pages on the old docs.automic.com site do not reliably redirect to the corresponding documentation pages on techdocs.broadcom.com.
    2. Anchor targets were removed from REST API documentation, making it impossible to link to specific parts of a page.


    Below I will provide an example that illustrates both problems.

    A few days ago, this link to the documentation of the system/processes endpoint of the REST API directed the reader to the specific part of the page where this endpoint is documented. Today, it simply redirects to the KB article Important Update: Migration of automic.com Digital Platforms.

    Even if the redirects to the correct page on the new techdocs site were working correctly, the relocated REST API documentation is missing the page anchors that would allow linking to specific sections of the documentation. The original Swagger documentation includes anchors like this:

    <a class="nostyle" href="#/system/listProcesses"><span>/{client_id}<wbr>/system<wbr>/processes</span></a>

    These anchor targets have been pruned from the REST API documentation, rendering them useless.

    <a class="nostyle"><span>/{client_id}<wbr>/system<wbr>/processes</span></a>

    Because the anchor targets are missing, URLs that include them will not work, and will just link to the top of the page instead.



  • 2.  RE: Documentation redirects not working. Anchor targets removed.

    Posted 25 days ago

    If I may add to this topic - searching in google also returns old links to docs.automic which does not redirect to the correct webpage of the new techdocs but rather to the KB article.
    This renders searching info in google nearly pointless.



    ------------------------------
    ------------------------------
    Automic SME @ DXC.Technology
    ------------------------------
    ------------------------------



  • 3.  RE: Documentation redirects not working. Anchor targets removed.

    Broadcom Employee
    Posted 25 days ago

    Hello Krum,

    I confirm this behavior as well and will work to have this rectified.

    Thank you,

    -Shannon



    ------------------------------
    _______________________________________
    Shannon Hebert
    AOD Automation Support
    Broadcom Software | Agile Operations Division
    _______________________________________
    ------------------------------



  • 4.  RE: Documentation redirects not working. Anchor targets removed.

    Broadcom Employee
    Posted 25 days ago

    Hello Michael,

    Thank you for raising this to our attention. We've engaged the appropriate team to correct this.

    Best,

    -Shannon



    ------------------------------
    _______________________________________
    Shannon Hebert
    AOD Automation Support
    Broadcom Software | Agile Operations Division
    _______________________________________
    ------------------------------



  • 5.  RE: Documentation redirects not working. Anchor targets removed.

    Posted 24 days ago
    Edited by Michael A. Lowry 24 days ago

    @Shannon Hebert: Thanks for your quick response.

    While you're looking at the REST API documentation, please see if there's anything you can do about the appearance. Compare it to the standard Swagger documentation from an AE REST process and I think you'll agree that the version hosted on the techdocs site is less than beautiful and hard to read.