How does Gitbook handle mono-repos?

[rijuchatterjee]

Ask a question, start a conversation, or make an annoucement

How does gitbook handles monorepos? I have a folder where multiple teams are pushing their code in their respective folders. How can this be managed?

[rodrcastro]

Hey @rijuchatterjee 👋

We have a really great resource in our docs explaining how monorepos work and how we support them with Git Sync. You can read more about it here..

If you have any questions about it, feel free to send us an email at [email protected]

[rijuchatterjee]

Thanks @rodrcastro. I tried to implement the github to gitbook sync but I ran into some issues. Below is the structure of my monorepo:

/monorepo
product-team1
documents.txt
product-team2
documents.txt

Can you help me in configuring the sync for the above directory structure? I have setup the authorization. I just need help in what/how to update the "project directory", also with the location and the contents of .gitbook.yaml. Moreover, I wanted to know how to ignore some files for which we do not want the sync?

[rodrcastro]

Hey @rijuchatterjee. As detailed in the guide, all you have to do is set the folder you'd like to sync from the repo as the project directory.

In your example, in the space you'd like to sync with the folder product-team1, you set the project directoy as:

./product-team1

GitBook will figure out all of the configuration from there, you don't need to add a .gitbook.yaml file if you don't have use for it. GitBook will also automatically create the Readme and Summary.md files if you don't have them in that folder. If you'd like to add one for each project in the future, simply add it to the root of the directory that is synced. In the example above, you'd put the .gitbook.yaml file under the folder product-team1:

./
  product-team1
    page-1.md
    README.md
    SUMMARY.md
   .gitbook.yaml

Please note that only Markdown files are supported with Git Sync.

[rijuchatterjee]

HI @rodrcastro Is it possible to sync all the "product" folders present in the "monorepo" directory in one single space? So that the documents inside the folder also appear in the space in different folders?

[rodrcastro]

@rijuchatterjee No, this is not possible. Git Sync can only sync one repo/folder per space. If you want to sync multiple repos/folders, they must be separated in multiple spaces.