garazdawi
commented
3 years ago Maybe the most pragmatic thing to do now is build the search.html page via index.html.src that ends up in the repo as an ignored artifact (i.e., copy into place as search.html and use a script to replace the contents), though that feels like tacking on tech. debt.
I think this is the best solution in the short-term. Another solution could be to include search.html in erl_docgen and just hide the link to it by default.
Maybe OTP team has plans to move away from that system to jekyll templates and thus this issue.
We do not. If anything we/I plan to bring bootstrap etc into erl_docgen in order to re-do the HTML layout for the docs, but that work is a long time away.
While, I'm not sure what the long term plans for what's pulled in via erlang/otp in regards to document pages, one thing is certain, we're currently creating a buggy situation per #41.
Specifically, the html files in
doc/docs(pulled in from erlang/otp and massaged via perl scripts) in conjunction with the new search page added in #41 hard codes layouts in a non-resusable fashion setting up a scenario where something in the template in the otp repo needs to be added, removed, or updated but not done in thesearch.htmlsource.Maybe the most pragmatic thing to do now is build the
search.htmlpage viaindex.html.srcthat ends up in the repo as an ignored artifact (i.e., copy into place as search.html and use a script to replace the contents), though that feels like tacking on tech. debt.Maybe OTP team has plans to move away from that system to jekyll templates and thus this issue.