Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rendering the development spec #16

Closed
Tieske opened this issue Jun 28, 2024 · 9 comments
Closed

Rendering the development spec #16

Tieske opened this issue Jun 28, 2024 · 9 comments

Comments

@Tieske
Copy link
Contributor

Tieske commented Jun 28, 2024

The current development spec is rendered in a weird way. The "Topology" heading is somehow moved to the very. end of the rendered page. Which is not where it lives in the source doc.

@Thalhammer
Copy link
Member

OK so I think I figured out whats happening. It looks like the way the grabrepo script works is it pulls all headings that are not mentioned in keepsections inside multiversion.yml from the latest develop version and not the version it was when the tag was done and then appends the keepsection sections at the end using the content of the tag. IMHO this is a very way of building the spec because it can cause the website version of the spec and the repo version at the given tag to heavily deviate. I have no idea why this extra step was implemented in the first place.

@Thalhammer
Copy link
Member

Should be fixed by #18

@Tieske
Copy link
Contributor Author

Tieske commented Jul 4, 2024

Seems the ToC is gone from the site now. Is that due to #18 ? unintended effect?

@Thalhammer
Copy link
Member

The ToC never worked for me, it threw all kinds of js errors in console, so I removed it. If its still needed I can take a look and rework it.

@Thalhammer
Copy link
Member

Though I think instead of bringing back the JS table of contents it might make more sense to use the hugo builtin and have it statically generated.

@Tieske
Copy link
Contributor Author

Tieske commented Jul 4, 2024

I think that for navigating the spec we need some sort of ToC. Which one, I do not care about really.

Unfortunately I have 0 skills on the techstack used here 😞

@Thalhammer
Copy link
Member

Unfortunately I have 0 skills on the techstack used here

Yeah I don't really either, but I'll check if I can bring something up.

@Thalhammer
Copy link
Member

TOC should be back with #26

@Tieske
Copy link
Contributor Author

Tieske commented Jul 4, 2024

Nice!

@Tieske Tieske closed this as completed Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants