Hi all, I am new to that list but I have an urgent question. We are using Docusaurus as Website-Framework (https://docusaurus.io/) and plan to share assets in Markdown via our new community website. While adding a copyright header in markdown sounds trivial, we would prefer to not mess up the generated website with all the copyright headers on each page. Thus we need to have a way to “comment” in markdown. Are there already any good-practices in the reuse-community how to handle this best and that also the reuse-tool is satisfied? Here is a thread for potential “comments in markdown”: https://stackoverflow.com/questions/4823468/comments-in-markdown
An example reuse-header could then look like e.g. : [comment]: <> (SPDX-FileCopyrightText: 2024 copyright owner) [comment]: <> (SPDX-License-Identifier: GPL-3.0-or-later)
Or
[//]: # (SPDX-FileCopyrightText: 2024 copyright owner)
[//]: # (SPDX-License-Identifier: GPL-3.0-or-later)
Any recommendations? Would that also work with the reuse-tool? In parallel I try to setup the reuse-tool in order to check how the tool would handle this.
Mit freundlichen Grüßen / Best regards
Marcel Kurzmann
Center of Excellence Open Source and InnerSource (BD/TOA-IDE2) Senior Expert Robert Bosch GmbH | Ziegelei 7 | 88090 Immenstaad | GERMANY | www.bosch.com Tel. +49 7545 202-279 | Mobil +49 172 1499942 | Telefax +49 7545 202-301 | Marcel.Kurzmann@bosch.commailto:Marcel.Kurzmann@bosch.com
Sitz: Stuttgart, Registergericht: Amtsgericht Stuttgart, HRB 14000; Aufsichtsratsvorsitzender: Prof. Dr. Stefan Asenkerschbaumer; Geschäftsführung: Dr. Stefan Hartung, Dr. Christian Fischer, Dr. Markus Forschner, Stefan Grosch, Dr. Markus Heyn, Dr. Frank Meyer, Dr. Tanja Rückert
Hi Marcel,
Thanks for considering REUSE for your new project!
I couldn’t extract whether you considered HTML comments in your files, and if so, what would speak against them. This is the default comment style the REUSE helper tool uses for .md files. So far, in my practical experience with GitHub, GitLab, various IDEs or the Hugo static site generator, this never failed on me.
Depending on the implementation, it’s questionable whether the comment will appear as a comment in a rendered HTML source code eventually, sometimes this is even configurable. But copyright/license information usually isn’t something I would need to hide from curious visitors.
I have no real-life experience with the other comment styles you proposed. Within REUSE, I cannot recall a discussion/issue where this was requested, so changing the default will probably not happen. However, the project might consider accepting an optional comment style.
Best, Max
-- Max Mehl Open Source Strategy & Governance Enterprise-Team Chief Technology Office (CTO) DB Systel GmbH / Deutsche Bahn
________________________________
Pflichtangaben anzeigenhttps://www.deutschebahn.com/pflichtangaben/20240806
Nähere Informationen zur Datenverarbeitung im DB-Konzern finden Sie hier: https://www.deutschebahn.com/de/konzern/datenschutz
Hi Marcel,
Am Montag 19 August 2024 13:28:21 schrieb Max Mehl:
I couldn’t extract whether you considered HTML comments in your files, and if so, what would speak against them.
to second Max, here is an example from us: https://github.com/csaf-poc/csaf_distribution/blob/main/README.md (Check how it is displayed and then the "raw" format", you see the comments in the top of the file)
```md <!-- This file is Free Software under the Apache-2.0 License without warranty, see README.md and LICENSES/Apache-2.0.txt for details.
SPDX-License-Identifier: Apache-2.0
SPDX-FileCopyrightText: 2024 German Federal Office for Information Security (BSI) https://www.bsi.bund.de Software-Engineering: 2024 Intevation GmbH https://intevation.de --> ```
This works with the reuse tool.
If it does not work with https://docusaurus.io/ You could consider opening an issue with them. AFAIR Raw HTML is allowed as part of most Markdown variants. (And a drawback of Markdown >;) ).
Regards Bernhard