Japanese translation: Convert the toc into sequential text

[rashikawat]

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.

[welcome[bot]]

:sparkling_heart: Thanks for opening this pull request! :sparkling_heart: 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! :checkered_flag:

• 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.

[spier]

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]

@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.

[yuhattor]

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!

[welcome[bot]]

Congrats on merging your first pull request! :tada: We here at The InnerSource Commons are proud of you! :sparkling_heart: Thank you so much for your contribution :gift:

[spier]

@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.

(1) 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.

(2) 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

(3) 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

[yuhattor]

Good catch! I fixed it now

[spier]

Good catch! I fixed it now

@yuhattor come again please. Which of the did issues above did you fix, and where/how did you fix them?

[yuhattor]

I fixed these issues.

1. Breaking changes to the links
2. Really long URLs

I acknowledge that 3 is still a problem. I added the comment. Let's add new patterns manually for now and revisit in few month! What do you say?

[spier]

@yuhattor the links in gitbook now look like this though, which is also a change: https://patterns.innersourcecommons.org/ja/start-as-experiment

i.e. the "/p/" in the URL is still gone.

You need to add this entry back into the toc to get the "/p/" in the URL.

[yuhattor]

I didn't notice that. Sorry about that.

I now fixed that https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/832