NLeSC / python-template

Netherlands eScience Center Python Template
https://research-software-directory.org/software/nlesc-python-template
Apache License 2.0
186 stars 76 forks source link

Broken link to Notice section of the eScience guide in project_setup.md #410

Open sjvrijn opened 2 months ago

sjvrijn commented 2 months ago

Under the 'Notice' header in the project_setup.md file, the link to the relevant guide section is broken, but apparently doesn't get reported as such by the markdown link checker.

The whole licensing chapter has been removed in https://github.com/NLeSC/guide/pull/296 in favor of linking to The Turing Way. Searching for 'notice' on that page however gives no results, so we need to find a new place to point to.

https://github.com/NLeSC/python-template/blob/003117cdc67e90eb8b407ce503e3c3b0dc329b8b/%7B%7Bcookiecutter.directory_name%7D%7D/project_setup.md?plain=1#L117

image

lyashevska commented 2 months ago

Perhaps this can be addressed together with #394?

bouweandela commented 2 months ago

The original content of the link was the following:

The NOTICE file is the Apache License' way of dealing with attributions. If you have any dependencies that are distributed under the Apache License, and you redistribute them (in either binary or source code form), then you must include the original NOTICE file(s) as well. If you have any attribution requirements of your own, you can add them in your own NOTICE file. If you do not distribute the dependencies, but only e.g. list them in a requirements.txt, then you do not need to include their NOTICE files in your program.

NOTICE should contain the following text, adapted with the product's name and copyright dates:

  [PRODUCT_NAME]
  Copyright [XXXX-XXXX] The Netherlands eScience Center, [PROJECT_PARTNERS]

  This product includes software developed at
  The Netherlands eScience Center (https://www.esciencecenter.nl/)
  For the [PROJECT_NAME] project

If any of the software dependencies has a NOTICE file, its contents shoud be appended below. Read more in the ASF licensing how-to.