Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation should contain a page with 3rd party licenses #6634

Open
ogoffart opened this issue Oct 23, 2024 · 1 comment
Open

documentation should contain a page with 3rd party licenses #6634

ogoffart opened this issue Oct 23, 2024 · 1 comment
Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT)
Milestone

Comments

@ogoffart
Copy link
Member

For our binary packages, we use cargo-about to generate a list of all licenses of dependencies.
Our rust user can easily do the same donloat all the licenses of their program.
What we should do anyway is to have this generated list on our documentation so that one can see all the dependencies. And maybe user can take this list for their C++ or Js/python.

Ideally we run cargo-about when generating the docs to generate something that can be shown in a section of the docs.

We can also try to see if we can generate machine readable format that can be consumed by users.

@ogoffart ogoffart added the a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT) label Oct 23, 2024
@ogoffart ogoffart added this to the 1.9 milestone Oct 23, 2024
@tronical
Copy link
Member

What we should do anyway is to have this generated list on our documentation so that one can see all the dependencies.

Since the list of dependencies depends on the choice of programming language / API, I think we need to invoke cargo-about for the documentation of three distributions:

  1. C++
  2. Node.js (we distribute binaries)
  3. Python

In addition, of course, we should continue to ship the output as part of the compiler/viewer/c++ etc. binary packages we ship. But I understand that this ticket is only about the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT)
Projects
None yet
Development

No branches or pull requests

2 participants