Skip to content

Japanese translation: Convert the toc into sequential text #818

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

Conversation

rashikawat
Copy link
Contributor

The order of the table of contents was all over the place, so I fixed it so that I could read them in order.
I also categorized each book by the main headings that were in the mind map.

@rashikawat rashikawat requested a review from yuhattor as a code owner May 9, 2025 09:03
Copy link

welcome bot commented May 9, 2025

Thank You Banner

💖 Thanks for opening this pull request! 💖 The InnerSource Commons community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines.

If you are submitting a new pattern, the following things will help get your pull request across the finish line! 🏁

  • Confirm that you have used our pattern template. Please remove any placeholder text and sections that your pattern did not need.
  • We run a number of automated checks on your PR. Please review the output of those checks on the PR itself, and see if any issues got flagged that you can fix yourself.
  • Make sure you have added your new pattern to the list of patterns in the main README.md. If you are unsure where to add your pattern, just let us know by commenting on your PR and we will help you.

This project has a small number of maintainers, volunteering their time to this project. So please be patient and we will get back to you as soon as we can. If we don't acknowledge this pull request after 7 days, feel free to chat to us about it in our Slack workspace.

@rashikawat rashikawat marked this pull request as draft May 9, 2025 09:05
@rashikawat rashikawat marked this pull request as ready for review May 9, 2025 09:07
@rashikawat rashikawat marked this pull request as draft May 9, 2025 09:07
@spier
Copy link
Member

spier commented May 9, 2025

Thank you @rashikawat for trying to improve the discoverability of the Japanese pattern translations.

The TOC is actually autogenerated programmatically. So if we want to change the order in there, we would have to change some scripts etc.

Interesting idea to create a different pattern grouping. Maybe we could express that in a markmap mindmap as well, if it should not work in the TOC directly.

@yuhattor could you help with this PR, as I cannot review the Japanese content that well ;)

FYI I have limited internet access at the moment, so further input from me will take some weeks.

@rashikawat
Copy link
Contributor Author

@spier Thanks for your comment!

Yes, what I wanted to do was to change the entire table of contents accordingly, since the current mind map is displayed as images and it is not possible to follow links to each pattern.
Also, the mind map has not yet been translated into Japanese.

So, rather than taking an approach of dynamically creating the list with a script, I decided to fix it and make it a static order for reading.

@spier spier changed the title Convert the toc into sequential text Japanese translation: Convert the toc into sequential text May 23, 2025
@spier spier added the Type - Translation Translating patterns into other languages label May 23, 2025
@rashikawat rashikawat marked this pull request as ready for review July 28, 2025 05:23
@yuhattor
Copy link
Member

yuhattor commented Aug 4, 2025

Thanks @rashikawat for improving the readability of the Japanese TOC! This manual organization makes much more sense for sequential reading.

I've added a comment to the TOC section to document this change for future maintainers:

<!-- Custom TOC ordering for enhanced readability - maintain when adding new patterns -->

This will help ensure that when new patterns are added, contributors know to update the manual ordering you've created. Great work on making the Japanese patterns more discoverable and easier to follow!

Copy link
Member

@yuhattor yuhattor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@yuhattor yuhattor merged commit 466e267 into InnerSourceCommons:main Aug 4, 2025
8 of 9 checks passed
Copy link

welcome bot commented Aug 4, 2025

Congratulations Banner
Congrats on merging your first pull request! 🎉 We here at The InnerSource Commons are proud of you! 💖 Thank you so much for your contribution 🎁

@spier
Copy link
Member

spier commented Aug 4, 2025

@yuhattor @rashikawat thank you for your work on the Japanese book.

I took a look at the Japanese book
https://patterns.innersourcecommons.org/ja

Your changes to the TOC may had some side-effects that were not intended.

Please check the points below, and decide if you want to keep them as is or fix some of them.

Breaking changes to the links

Your change means a breaking change to the Japanese pattern URLs. e.g.
old: https://patterns.innersourcecommons.org/ja/p/start-as-experiment
new: https://patterns.innersourcecommons.org/ja/karasuru/start-as-experiment

Btw the "p" in the URL was configured by this entry in the TOC.

Really long URLs

gitbook uses the title of sections in the TOC to form the URL.

For some patterns you have these really long URLs now. e.g.

https://patterns.innersourcecommons.org/ja/readmemdcontributingmdkomyunikshontsrunadosuruniha/base-documentation

New Japanese patterns are not automatically added to the book

By making the TOC static, new patterns translated to Japanese will not be added to the book automatically.
i.e. for each pattern you will have to remember to add them manually to the TOC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type - Translation Translating patterns into other languages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants