search

mapstruct / mapstruct.org

Web site of the MapStruct project
63 stars 40 forks source link

Fix broken links in TOC of MapStruct site FAQ #123

Closed jccampanero closed 3 years ago

jccampanero commented 3 years ago

The links in the table of contents of the frequency asked questions (https://mapstruct.org/faq/) in the Mapstruct site seem to be broken.

The problem has to do with the different functions applied against the H2 headings text in the Hugo shortcode definition (https://github.com/mapstruct/mapstruct.org/blob/master/themes/mapstruct/layouts/shortcodes/faq_question.html) and the FAQ TOC partial (https://github.com/mapstruct/mapstruct.org/blob/master/themes/mapstruct/layouts/partials/faq_toc.html).

One possible solution is the one suggested and provide a trailing lower function in the shortcode definition as well.

A companion change can be done in the core Mapstruct repo to provide the right values for the constants defined in MessageConstants (https://github.com/mapstruct/mapstruct/blob/985ca2fe64745607b003c71a87559dfbe8ffe482/processor/src/main/java/org/mapstruct/ap/internal/util/MessageConstants.java#L11-L12). The change will also affect to several tests.

filiphr commented 3 years ago

Thanks for this PR @jccampanero. I had a look at it and fixed this in https://github.com/mapstruct/mapstruct.org/commit/96169f7ebe5ab29af3caf207eb4cff656632bfa3. I removed the lower from the faw_toc.html and I also added a new section for the links we use in the Mapstruct repo. This was needed, because we have releases that are showing those links to users and we can't change already released version.

jccampanero commented 3 years ago

You are welcome @filiphr.

I reviewed the indicated commit and I agree with you, I will in addition solve all the references for ambiguous and qualifier in previous releases of the library.

I'm sorry I can't contribute to the project this time around. I hope to be of more help next time.

filiphr commented 3 years ago

I'm sorry I can't contribute to the project this time around. I hope to be of more help next time.

Please don't say sorry. The sheer fact that you caught this and made us aware about it is a contribution. Otherwise it would not have lead us to fixing the problem.