Currently, the module uses a (btw, genius) mode of displaying the README.md file content as the Help page via the /admin/help/cookiebot URL path on a given website. For reference, it's implemented in the cookiebot.module file at line 18:
$text = file_get_contents(drupal_get_path('module', 'cookiebot') . '/README.md');
if (!\Drupal::moduleHandler()->moduleExists('markdown')) {
return [
'#markup' => str_replace("\n", '<br />', $text),
'#allowed_tags' => ['br'],
];
}
Personally, I really like the idea, how creator built in Markdown-support once the necessary filter module is installed on the site:
However, my biggest concern is that this way the Help page of the module will be not translatable, as localization teams can't access code-level files such as a README file. Instead, I'd suggest following the "Drupal-way" and provide a proper Help page with use of appropriate t() functions. I also tried to dig up Docs section on D.org, found only this Module Documentation and Help instructions page.
If module maintainers agree, then I'd be happy to provide a patch for this.
| Comment | File | Size | Author |
|---|
Comments
Comment #2
a.milkovskyHi, thank you for the input. A proper Help page sounds good to me, let's do it.
Comment #3
dmsmidtThe problem is that the documentation changes very fast and that multiple versions of the documentation need to be kept in sync.
I think outdated documentation or documentation that is not in sync between places is worse than not being able to translate it.
I would suggest to only consider this if we have a stable release and Cookiebot themselves also has a multilingual site.
Otherwise we are being very forward with it while the service we depend on is not.
Edit: @Balu Ertl of course you are strictly very right in this, and thanks for your help and taking the time to create this issue.
Comment #4
a.milkovskySet to minor, as we can postpone it until the major release.