ontoportal / documentation

Source code for OntoPortal user, admin and developer guides
https://ontoportal.github.io/documentation
BSD 2-Clause "Simplified" License
3 stars 9 forks source link

Federated documentation starter #53

Closed galviset closed 3 weeks ago

galviset commented 2 months ago

This pull request contains all changes needed to start the federated documentation, from the Jekyll configuration to the content of the documentation itself. The shared content is based on EcoPortal's draft documentation which has been slightly edited to be generic enough for most portals. While most of the shared content is there, the user documentation for each portal needs to be done (either by reusing the available shared content, either by adding their own specific bits of documentation).

Bilelkihal commented 2 months ago

@galviset The issue of the last week was not related to using the same page title, it was caused by the includes of the variables not working properly. In fact the config that you did add the values just in the scope of the specific docs, but in our case we need to use the variables in the shared documentation instead and since we have only one shared documentation then we can't really use this solution and we can't run away from passing the variables in each include

galviset commented 2 months ago

@Bilelkihal This is weird. I tried to rollback to the include system of variables (so passing variables in each include and change page. by include. in shared documentation), and I still witness the same issue. The scope-specific variables were working correctly when I tested them, but it required to change include.variable by page.variable in shared docs. Included files still have access to page variables.

Bilelkihal commented 2 months ago

No it works perfectly when u add the includes. you can see also for you that ontoportal and ecoportal has the same page title for home page and it's working.

in this video I just added the includes and now it's working

https://github.com/ontoportal/documentation/assets/61744974/587e1785-1cd2-4dc4-a4e0-66bf0d3f2cf0

galviset commented 2 months ago

@Bilelkihal That pull request now contains only the documentation content for review.

galviset commented 2 months ago

Done, here is the entire content divided in smaller PRs: