Explore current workflow for compiled books (submodules)

[SarahAlidoost]

There is an example in https://github.com/TeachBooks/Nested-Books on how to share content between books using git submodule. Based on that example, in the branch nested_book_submodule, I added a workflow for compiling a book including another example, see nested_book_workflow.md.

[rlanzafame]

glad you found that! @Tom-van-Woudenberg will be happy. we try to keep that type of stuff updated in our manual, in case you haven't seen it.

the submodules thing is nice, but i'm not 100% sold on it, because in the end it's key to have every page be 100% incorporated as-is in the repo of the non-sub-module book

[Tom-van-Woudenberg]

I missed this, but this looks awesome! @SarahAlidoost , do you think we should replace the 'adding external content...' (https://teachbooks.tudelft.nl/jupyter-book-manual/external/Nested-Books/README.html#adding-external-content-to-your-book) of the README with this?

[SarahAlidoost]

glad you found that! @Tom-van-Woudenberg will be happy. we try to keep that type of stuff updated in our manual, in case you haven't seen it.

Thanks for the link 👍

the submodules thing is nice, but i'm not 100% sold on it, because in the end it's key to have every page be 100% incorporated as-is in the repo of the non-sub-module book

If I got it right, you're suggesting that every page should be stored in the repository of non-submodule book. Can you please explain why that's important? One reason would be that with submodules, users can't edit the content directly through the GitHub interface of the non-submodule book (I am going to add this point to the document). Are there any other reasons for storing all the actual content in the repo of the non-sub-module book?

[SarahAlidoost]

I missed this, but this looks awesome! @SarahAlidoost , do you think we should replace the 'adding external content...' (https://teachbooks.tudelft.nl/jupyter-book-manual/external/Nested-Books/README.html#adding-external-content-to-your-book) of the README with this?

Thanks! The idea is to explore how to merge content between books programmatically. We’re looking into using Git submodules, and other possible alternatives. I put together the workflow document as a starting point to discuss the pros and cons. So, I’d say this is still a draft.