search

ietf-wg-ohai / oblivious-http

Oblivious HTTP
Other
23 stars 12 forks source link

link fest #244

Closed martinthomson closed 1 year ago

martinthomson commented 1 year ago

Comment by @paulwouters

It seems some automated tooling was used to creating links within the document, eg for "key configuration": 7 times in Section 3, pointing to a few lines below in section 3.1, and even one time within section 3.1 itself pointing recursively back to itself, and 3 more times in section 3.2, and then I stopped counting.

The same for things like "client", Oblivious Gateway Resource", etc etc culminating in Section 5 that's more blue than black, making the blue links, uhm, oblivious :P

martinthomson commented 1 year ago

There are a few tooling changes that might be worth pursuing here, but I don't intend to make any changes in response to this issue.

martinthomson commented 1 year ago

For reference: https://github.com/ietf-tools/datatracker/pull/5071 and https://github.com/ietf-tools/xml2rfc/pull/963 and https://github.com/cabo/kramdown-rfc/pull/185

paulwouters commented 1 year ago

I believe the tooling used still creates a large number of useless and distracting links in the document. I've created an agenda item to this weeks IESG's Informal meeting to discuss this.

cabo commented 1 year ago

Was there any outcome of the IESG discussion?

(The tooling does what it is told to do. Auto-creating links obviously needs to be applied sparingly... We did have some discussion about making auto-created links less visible/inviting than manually created ones, but RFCXML is not very flexible here.)

cabo commented 1 year ago

Oh, that change actually happened:

https://github.com/ietf-tools/xml2rfc/commit/dbdda51a16083da0762355ebe0902c3bc2a78a39

In xml2rfc 3.17.0.

martinthomson commented 1 year ago

Steps have been taken. The index remains problematic, but that's (again) on xml2rfc.