search

NetAppDocs / cloudinsights

Cloud Insights Documentation
https://docs.netapp.com/us-en/cloudinsights/
5 stars 18 forks source link

another table that isn't a table and that is breaking translation #2647

Open ntap-bmegan opened 3 hours ago

ntap-bmegan commented 3 hours ago

Summary

  1. Do not manually create a TOC with links. That's what the right sidebar is for.
  2. If you have to put "back to top" links in an article, the article is too long and needs to be split into separate articles.
  3. Do not use single-column tables ever for any reason.
  4. We do not support :toc-title:, :description:, toc::[], :toclevels: and possibly other notation that is present that I haven't found in the 10k-plus lines of notation.

This page causes my browser to hang, but right now I care more that it causes our translation system to come to a crawling halt. Specifically, it's failing at reference_data_collector_support_matrix.adoc line 10262)

image

This article cannot continue to exist in this form.

Reference: https://github.com/NetAppDocs/oncommand-insight

Public issues must not contain sensitive information

ntap-bmegan commented 2 hours ago

Edit to add page link: https://docs.netapp.com/us-en/cloudinsights/reference_data_collector_support_matrix.html

ntap-bmegan commented 2 hours ago

At a minimum, the translation problem needs to be resolved by then next push to production or thurs 31 oct 2024, whichever comes first, or we will remove your merge permissions until a suitable PR is opened in the internal repo.

jenatnetapp commented 2 hours ago

@netapp-alavoie, NetAppDocs authors are responsible for understanding and complying with our authoring and content standards. Thank you for your attention to this.

netapp-alavoie commented 2 hours ago

I'm working to resolve the four points noted. Once these are resolved, can we check that the translation problem is fixed?

Understood.

ntap-bmegan commented 2 hours ago

The immediate focus if you want to prioritize is the "table" starting at the linked code line above. That's what is breaking translation.

netapp-alavoie commented 2 hours ago

I'll move that table to a bulleted list, along with the few other single-column tables in the page. Also removing the "toc" likes and the "Top|back to top" links.

I'll also refresh my understanding of these areas. Can you point me to the content standards that talk about them?