grpc / grpc.io

Repository for the gRPC website and documentation
https://grpc.io
Other
423 stars 450 forks source link

Duplicate partial inclusion in head.html and head-end.html #775

Open chalin opened 3 years ago

chalin commented 3 years ago

@aidanranney: this is a Docsy migration followup question concerning these issues:

Investigating this a bit I noticed the following:

(1) https://github.com/grpc/grpc.io/blob/main/layouts/partials/hooks/head-end.html contains:

{{ partial "google-analytics.html" . }}
{{ partial "meta.html" . }}
{{ partial "favicons.html" . }}

(2) But https://github.com/grpc/grpc.io-docsy/blob/e95da39c9933afe159b74b0d6b5b71407aab7d7d/layouts/partials/head.html:

I'm sure that the duplication wasn't intentional, but what was the original intent? Was head-end.html created by mistake, or was the intent to customize head.html (by removing the elements that were being added to head-end.html)?

/cc @nate-double-u @celestehorgan

aidanranney commented 3 years ago

👋 @chalin - I believe head-end.html was created purposefully to give an entry point documented in the code for extending head.html. I've lost the full context on the inclusion of those partials in that file, though at one point we were customizing the head.html partial, which went through iterations. These lines appear to be either missed in cleanup or a rebase.

celestehorgan commented 3 years ago

@chalin – I agree that this wasn't intentional. Removing the duplicated partials will 100% fix this.