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

Move the sidebar navigation definition for the website to this repo #717

Closed
ghys opened this issue Jun 12, 2018 · 7 comments
Closed

Move the sidebar navigation definition for the website to this repo #717

ghys opened this issue Jun 12, 2018 · 7 comments
Assignees

Comments

@ghys
Copy link
Member

ghys commented Jun 12, 2018

Instead of having to modify the website's config when e.g. a new page is added to the navigation, define it in a file in this repo and import it in the config during the website's build (like it's done for the add-ons except the file isn't generated but copied).

@ghys ghys self-assigned this Jun 12, 2018
@Confectrician
Copy link
Contributor

Maybe we should combine this with some changes for #665 and #700

@Confectrician
Copy link
Contributor

@ghys can i help you with this somehow already?

@ThomDietrich
Copy link
Member

@ghys (after a cleanup of the docs repo) why is a element-wise list needed? Can't you just import he whole repo...

@ghys
Copy link
Member Author

ghys commented Jun 17, 2018

@ghys can i help you with this somehow already?

Actually I indended to do it while building the "preview" VuePress site we talked about, and put that into the resulting ".vuepress" folder - basically it's just a matter of copying https://github.com/openhab/website/blob/743f0b867e4d26a5a6a3116a12f6344295ef25d6/.vuepress/config.js#L177-L307 into a .js file and require()-ing it at the top.
Building the preview site would also require a refactoring prepare-docs.rb (mainly put everything into subroutines with parameters for target folder etc., the website build script would import and reuse those subroutines), and moving it here as well.
I'll start working on it after #700 is in place.

@ghys (after a cleanup of the docs repo) why is a element-wise list needed? Can't you just import he whole repo...

Ordering the sidebar links and controlling the title of certain entries which might differ from the title of the pages themselves - and generally staying in control :). This config is only for building the sidebar, basically it's the equivalent of https://github.com/openhab/openhab-docs/blob/gh-pages/_includes/user-menu.html

@ThomDietrich
Copy link
Member

basically it's the equivalent of https://github.com/openhab/openhab-docs/blob/gh-pages/_includes/user-menu.html

I see.
I'll have to do a deep dive once I am finished with my thesis and back in the game ;)

@Confectrician
Copy link
Contributor

Hey @ghys if i am right this issue should have been solved by you some time ago correct?

We could close it then.

@ghys
Copy link
Member Author

ghys commented Dec 12, 2020

yep!

@ghys ghys closed this as completed Dec 12, 2020
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

3 participants