-
Notifications
You must be signed in to change notification settings - Fork 181
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
Host translations in gitbook, using monorepo approach #578
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spier
added
(Self-) Hosting
Everything around artifact rendering and presentation.
Type - Translation
Translating patterns into other languages
labels
Aug 24, 2023
…y pattern" This reverts commit edc7fce.
In early tests of this, I saw something that looked like a bug:
It looks like the issue somehow resolved itself though. |
spier
changed the title
Host translations, using monorepo approach
Host translations in gitbook, using monorepo approach
Aug 24, 2023
This was referenced Aug 26, 2023
…file was changed and why
spier
requested review from
yuhattor,
lenucksi and
NewMexicoKid
as code owners
August 26, 2023 22:43
Notes for how to configure the gitbook space.
|
This reverts commit 30a8159.
Merging to main, so that I can deploy to Production. |
rmarting
pushed a commit
to rmarting/InnerSourcePatterns
that referenced
this pull request
Feb 29, 2024
…mons#578) * Remove the main gitbook yaml file. Need to be sure that config is picked up from subfolders. * Change config of the en book * Change config of the ja book * Change config of the zh book * Generate the TOCs for all books in a GHA matrix build * Change commit messsage in book.yaml workflow run to make clear which file was changed and why * Improve documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
(Self-) Hosting
Everything around artifact rendering and presentation.
Type - Translation
Translating patterns into other languages
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current approach for hosting the translations of our patterns is brittle.
As each book needs a custom
.gitbook.yaml
configuration, we have a script that copies the file to the root of the repo, depending on which book we want to render. That in turn also leads to the need for longstanding branches likebook-ja
,book-zh
, etc.All of this leads to various issues though, and the deployment of new versions of the book is still largely manual, which effectively means that we rarely do it :( See an example of that here: #493
Requirements
main
Solution: monorepo configuration
In the meantime gitbook has created a configuration option to host multiple gitbooks from monorepos.
In this PR we are trying out how that works, and if it is an approach that would be better suited for hosting our translations.
How it works:
book/jp
(these folders contain the custom content and configuration files for the specific book - in this example for the Japanese book).gitbook.yaml
, which points to the content for the given bookpatterns/...
and for the translation intranslations/jp/...
TODO
book/en/README.md
,translation/README.md
.github/workflows/book.yaml
- on any push tomain
, regenerate the TOCs for all booksbook-jp
)main
, using the new monorepos approach)main
branch any more, using the old configurationmain
into #InnerSource patterns book translation into Brazilian Portuguese #577 to prepare the monorepo configuration for the new Brazilian Portuguese translationbook-*
and PRs/issues that are now obsolete