What's Happening?
Broadcom has recently completed the migration of its Automic documentation from docs.automic.com to techdocs.broadcom.com. This migration has resulted in significant issues with documentation accessibility, specifically affecting links to specific REST
API endpoints. Users are reporting two main problems: deep links to documentation pages on the old domain do not reliably redirect to their corresponding pages on the new techdocs.broadcom.com site, and anchor targets within the relocated REST API documentation have been removed. This removal means that URLs designed to link to specific sections of a page now only direct users to the top of the page, rendering precise navigation impossible. Additionally, search engine results still point to the old docs.automic.com links, which often redirect to a general knowledge base article rather than the specific documentation, making it difficult for users to find relevant information through search engines.
Why It's Important?
The disruption in documentation accessibility can have a significant impact on developers, system administrators, and other users who rely on accurate and easily navigable technical documentation for Broadcom's Automic Workload Automation products. Broken links and the inability to deep-link to specific API endpoints can lead to increased frustration, wasted time, and potential errors in implementation or troubleshooting. For businesses utilizing Broadcom's software, this can translate into reduced efficiency, delayed project timelines, and increased support costs as users struggle to find necessary information. The issue also affects the broader ecosystem of third-party tools and integrations that might rely on these documentation links. The lack of proper redirects and the removal of anchor targets suggest a potential oversight in the migration process, highlighting the critical importance of thorough planning and testing when transitioning large-scale technical documentation platforms to ensure continuity and user experience.
What's Next?
Broadcom has acknowledged the issue, with a representative stating that the appropriate team has been engaged to rectify the problems. Users can expect efforts to be made to correct the redirect failures and restore the functionality of anchor targets within the documentation. This will likely involve implementing proper 301 redirects from the old URLs to the new ones and re-establishing the necessary HTML anchors within the REST API documentation pages. Additionally, Broadcom may need to work on updating its search engine optimization (SEO) to ensure that search results correctly point to the new, functional documentation pages. Regular communication from Broadcom regarding the progress of these fixes would be beneficial for its user community. Users will need to monitor the techdocs.broadcom.com site for improvements and potentially update any internal links or bookmarks they maintain.
Beyond the Headlines
This incident underscores the broader challenges and complexities involved in large-scale digital migrations, particularly for critical technical resources. Beyond the immediate inconvenience, such issues can erode user trust and confidence in a company's commitment to supporting its products. It also highlights the often-underestimated value of robust information architecture and persistent URLs in the digital age. For companies, maintaining stable and accessible documentation is not just a technical task but a crucial aspect of customer support and product usability. The reliance on search engines for information discovery means that effective SEO and proper redirection strategies are as important as the content itself. This situation could prompt Broadcom and other technology companies to review their migration protocols and invest more in ensuring seamless transitions for their online resources, recognizing the significant impact on their user base and brand reputation.
