InnerSourceCommons / managing-innersource-projects

Managing InnerSource Projects book
https://innersourcecommons.gitbook.io/managing-innersource-projects/
12 stars 15 forks source link

Rename Measuring intro file to get better URLs #52

Closed spier closed 9 months ago

spier commented 9 months ago

gitbook generates the URLs for the markdown files by using the filename itself. When the same filename exists multiple times in different directories, it applies some custom logic to prevent collisions. Not sure why.

You can see this in effect in the current "What, When and How to Measure" section, as the corresponding markdown file is called "introduction.md" which already exists, you guessed it, in the "Introduction" chapter :)

This leads to unfortunate URLs like this:

https://innersourcecommons.gitbook.io/managing-innersource-projects/introduction-1
https://innersourcecommons.gitbook.io/managing-innersource-projects/introduction-1/goals

How to fix

This PR fixes this by renaming measuring/introduction.md to measuring/measuring.md.

This will also have the extra benefit of generating a nicer landing page for the whole chapter, which will then be https://innersourcecommons.gitbook.io/managing-innersource-projects/measuring

Screenshots

Screenshot 2023-10-21 at 22 38 25

Screenshot 2023-10-21 at 22 38 34

spier commented 9 months ago

This change as a slightly more "breaking" nature to it, therefore I will leave this here for somebody to review :)

spier commented 9 months ago

Lovely. The chapter is now live at the modified URL at https://innersourcecommons.gitbook.io/managing-innersource-projects/measuring