Performance Tuning documentation page missing

[djcarlin]

I was looking up timeout settings docs:

https://docs.trafficserver.apache.org/records.config#proxy-config-http-keep-alive-no-activity-timeout-out

They all say "See Timeout Settings for more discussion on Traffic Server timeouts." but if you click on the link you get 404.

Should this https://docs.trafficserver.apache.org/records.config page even exist? I was expecting something with a documentation version in the path:

https://docs.trafficserver.apache.org/en/9.1.x/

[ywkaras]

Dude, it's trafficserver. I think you're getting unrealistic hopes cause I asked for a pony and actually got one.

[mlibbey]

Yeah -- that's weird. Normally, the page you started with should have had admin-guide/ as a path. https://docs.trafficserver.apache.org/admin-guide/files/records.config.en.html (or, like you point out, a version in a path earlier -- like https://docs.trafficserver.apache.org/en/8.1.x/admin-guide/files/records.config.en.html

Agree that /records.config shouldn't exist without the admin-guide/ path.

[ezelkow1]

This came up during the CI rework. There are a handful of placeholders like that because some people, mainly @zwoop :), liked having those shorthand shortcuts to specific files. So we have specific remaps for specific files like that

We did have to fix them once already but maybe we are still missing some for them

[mlibbey]

Just had an internal report of the same. Google has the "bad" page as the first result for "ats records.config"

[bneradt]

Thanks for pointing this out Dave!

There's two unrelated things mentioned in this thread:

Should this https://docs.trafficserver.apache.org/records.config

https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.trafficserver.apache.org_records.config&d=DwMCaQ&c=sWW_bEwW_mLyN3Kx2v57Q8e-CRbmiT9yOhqES_g_wVY&r=QqpSWgNGj0TQqWr3_U9U8a-TyrKRt3NR6Cr-LMDTUZE&m=BTSkUOqzmvd6nfkF3JY2ba0Z20zvKL2lHcON3iUvylg&s=jF8Wrl9rzw8O0_mkRTGzgt6oZvvBiEWw7geFXXuXIjU&e= page even exist? I was expecting something with a documentation version in the path:

This understandably looks strangely short, but this is fine. As Evan pointed out, this is an intentionally configured shortcut that allows easy linking to records.config documentation. The shortcut is in place because it is frequently accessed.

They all say "See Timeout Settings for more discussion on Traffic Server

timeouts." but if you click on the link you get 404.

This, on the other hand, is definitely not fine and it's a problem. In this case that you point out, they are generated via :ref:admin-performance-timeouts references in various places in our records.config.en.rst code here: https://github.com/apache/trafficserver/blame/master/doc/admin-guide/files/records.config.en.rst#L469

That label is defined here: https://github.com/apache/trafficserver/blame/master/doc/admin-guide/performance/index.en.rst#L212

Here's another, different link to a different label that is broken: https://docs.trafficserver.apache.org/records.config#overridable

Following the " Configuration Remap Plugin" link also results in a 404.

Are all our internal links to labels broken? I'll look into this.

On Wed, Dec 1, 2021 at 2:01 PM Evan Zelkowitz @.***> wrote:

This came up during the CI rework. There are a handful of placeholders like that because some people, mainly @zwoop https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_zwoop&d=DwMCaQ&c=sWW_bEwW_mLyN3Kx2v57Q8e-CRbmiT9yOhqES_g_wVY&r=QqpSWgNGj0TQqWr3_U9U8a-TyrKRt3NR6Cr-LMDTUZE&m=NanTA10xQwpqW8FjXP8AQQ45tD1JmUdI67pcCrgUoGQ&s=EKNC1UB6AXSOyPYv6J2EhWJYqP3qgEGrfAIN3uyuH1E&e= :), liked having those shorthand shortcuts to specific files. So we have specific remaps for specific files like that

We did have to fix them once already but maybe we are still missing some for them

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_apache_trafficserver_issues_8542-23issuecomment-2D984008027&d=DwMCaQ&c=sWW_bEwW_mLyN3Kx2v57Q8e-CRbmiT9yOhqES_g_wVY&r=QqpSWgNGj0TQqWr3_U9U8a-TyrKRt3NR6Cr-LMDTUZE&m=NanTA10xQwpqW8FjXP8AQQ45tD1JmUdI67pcCrgUoGQ&s=bF-17PUGeU1ALczmdXSwNy4yHE8wyUPBak70Aqzo0bY&e=, or unsubscribe https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_ACMJMY6OFZFAKDWA54GFCOLUOZ5KXANCNFSM5JEN6O4A&d=DwMCaQ&c=sWW_bEwW_mLyN3Kx2v57Q8e-CRbmiT9yOhqES_g_wVY&r=QqpSWgNGj0TQqWr3_U9U8a-TyrKRt3NR6Cr-LMDTUZE&m=NanTA10xQwpqW8FjXP8AQQ45tD1JmUdI67pcCrgUoGQ&s=Y3uiWjxYvfXxcIvDZPD25yTG49VMLKU3zWzeT_Rkp8Y&e= .

[SolidWallOfCode]

The internals are fine and the relative links are fine. The problem is entirely landing on a page like "https://docs.trafficserver.apache.org/records.config". THAT IS WRONG. It should be "https://docs.trafficserver.apache.org/admin-guide/files/records.config.en.html". The result is the brower is using the wrong URL and does the relative computation incorrectly. I'm not sure Sphinx can be set to use absolute URLs because those are fundamentally unknowable at the time the documentation is generated.

[mlibbey]

where is the shortcut configured? I don't see a raw records.config in the /doc/docbuild/html/ after building; and I haven't been able to find it in source. Is it done in the docs ATS directly? (and if so, can we change it from map to redirect_temporary ?)

[bneradt]

I fixed this via httpd configuration settings. I removed the remap.config rule to handle the shortcut and configured redirection via httpd, as was done in the earlier CI configuration. This allows both the shortcuts to work and the links from pages that were loaded via a shortcut URL.

Thus, if you now follow this shortcut link: https://docs.trafficserver.apache.org/records.config#proxy-config-http-keep-alive-no-activity-timeout-out

The link "Timeout Settings" now works.

Thank you @djcarlin for reporting this.