slachiewicz opened a new pull request, #243: URL: https://github.com/apache/maven-changelog-plugin/pull/243
Part of the estate-wide move of the remaining FAQ pages from FML to Markdown, following the pattern reviewed in apache/maven-artifact-plugin#231, apache/maven-assembly-plugin#1354 and apache/maven-javadoc-plugin#1358. ### Two commits, deliberately 1. **A pure rename**, `src/site/fml/faq.fml` -> `src/site/markdown/faq.md`, no content change. 2. **The rewrite**, written by hand. Git records a rename plus a rewrite in one commit as a delete and an add, which stops `git log --follow`. Splitting them keeps the history. **Please merge or rebase rather than squash.** ### Anchors are preserved, and that is the point This page has been on maven.apache.org for years and is linked from outside. FML derives its anchor from the `<faq id=...>` attribute, and where that attribute is not a valid XML name `DoxiaUtils.encodeId` rewrites it at render time. The `<a id>` elements here reproduce **the anchor the live site serves today**, not the raw attribute. The `id` spelling is deliberate rather than `name`: maven-site-plugin 3.21.0 silently drops a `name` attribute from inline HTML while leaving the element in place, so the build stays green and every deep link stops working (seen for real in apache/maven-gpg-plugin#335). `id` works on every version and is the correct HTML5 form. ### Verification Built the site before and after and compared the set of anchors the generated `faq.html` actually serves: ``` How_can_I_debug_the_SCM_command How_do_I_use_this_plugin_with_Perforce.3F I_think_I.27ve_found_a_bug_in_this_plugin.2C_what_do_I_do My_changelog_report_is_blank.2C_but_it_shouldn.27t_be The_Developer_Activity_report_is_blank.2C_but_the_other_reports_are_fine What_is_Software_Configuration_Management_or_SCM What_is_the_difference_between_the_Changelog_plugin_and_the_Changes_plugin Where_can_I_find_a_working_configuration_for_this_plugin Why_do_the_child_modules_of_my_multi_module_project_have_wrong_SCM_URLs Why_do_the_dates_look_weird_in_the_report_when_I_use_the_dateFormat_parameter bodyColumn top ``` Every anchor served before is still served after. The `<head>` is byte-identical, so title and metadata are unchanged, and every link target on the page is unchanged. `site.xml` needs no edit - both paths render to `faq.html`. ### What is lost FML generates a `[top]` back-link after each answer. Those are dropped rather than hand-written. The question renders as an `h3` heading instead of a definition term. Nothing else changes. <sub>Drafted with Claude - please verify</sub> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
