contour icon indicating copy to clipboard operation
contour copied to clipboard

site: upgrade document missing the inline table of contents

Open jpeach opened this issue 5 years ago • 4 comments

On the upgrade page, https://projectcontour.io/resources/upgrading/, there is supposed to be a page table of contents on the top left. If you render this using make site-devel it is there, but on the public site, it just renders as an empty div box.

Screen Shot 2020-01-10 at 8 51 06 am

jpeach avatar Jan 09 '20 21:01 jpeach

Not seeing the table of contents with make site-devel or the public site 👀

sunjayBhatia avatar Dec 07 '20 19:12 sunjayBhatia

looks like a missing <div id="toc" class="navigation"></div> (though that being on the top right takes up quite a bit of space/looks unwieldy

sunjayBhatia avatar Dec 07 '20 19:12 sunjayBhatia

Looks like https://github.com/projectcontour/contour/pull/3179 didn't actually fix the issue on the live site, though it did fix my local dev rendering

sunjayBhatia avatar Dec 17 '20 17:12 sunjayBhatia

It looks like this is because the upgrade page is inheriting the page layout instead of the docs layout. For example, docs pages inherit the docs layout, https://raw.githubusercontent.com/projectcontour/contour/main/site/content/docs/main/_index.md but the upgrade page uses the page layout in the frontmatter, https://raw.githubusercontent.com/projectcontour/contour/main/site/content/resources/upgrading.md.

Since this page is also a versioned page, we should also consider moving it from the /resources folder to the docs/main folder.

Layouts: docs - https://github.com/projectcontour/contour/blob/main/site/themes/contour/layouts/_default/docs.html and page - https://github.com/projectcontour/contour/blob/main/site/themes/contour/layouts/_default/page.html

a-mccarthy avatar Oct 12 '22 18:10 a-mccarthy