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

docs: Remove academics files #1380

Conversation

rzr
Copy link
Contributor

@rzr rzr commented May 8, 2021

Those generated files are not explicitly under Apache-2.0 licence
and AFAIK they can not be regenerated from missing (latex?) sources.

To avoid licence mixup.
It would help to have those files published elsewhere.
Meanwhile online (Github) links are used.

Debian had to repack the source package to make tarball compliant with DFSG
dispite debian tools are known to be trustworthy,
this extra step would add weakess in the chain of trust

Cleanup done upstream would make distribution safer.

Bug: #1161
Bug-Debian: https://salsa.debian.org/python-team/packages/tuf/-/merge_requests/11
Relate-to: #263 (comment)
Signed-off-by: Philippe Coval [email protected]

Please fill in the fields below to submit a pull request. The more information
that is provided, the better.

Fixes #

Description of the changes being introduced by the pull request:

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

rzr added a commit to CrossStream/tuf that referenced this pull request May 8, 2021
Those generated files are not explicitly under Apache-2.0 licence
and AFAIK they can not be regenerated from missing (latex?) sources.

To avoid licence mixup.
It would help to have those files published elsewhere.
Meanwhile online (Github) links are used.

Debian had to repack the source package to make tarball compliant with DFSG
despite debian tools are known to be trustworthy,
this extra step would add weakess in the chain of trust

Cleanup done upstream would make distribution safer.

Bug: theupdateframework#1161
Bug-Debian: https://salsa.debian.org/python-team/packages/tuf/-/merge_requests/11
Relate-to: theupdateframework#263 (comment)
Forwarded: theupdateframework#1380
Signed-off-by: Philippe Coval <[email protected]>
@rzr rzr force-pushed the sandbox/rzr/review/master branch from 005831a to 6f60cec Compare May 8, 2021 13:53
@trishankatdatadog
Copy link
Member

I don't have strong feelings, but is there a way to tell Debian package not to include certain files?

@rzr
Copy link
Contributor Author

rzr commented May 8, 2021

yes debian has everything to repack archive with files excluded see:

https://salsa.debian.org/python-team/packages/tuf/-/commit/d701faef3d166761993cb0d9595775ee56700e78#adb7f75f79e3bb85eb62912a2904c5d24af878fb_6_6

BTW package in NEW queue: \o/

https://ftp-master.debian.org/new/tuf_0.17.0+dfsg-1.html

@jku
Copy link
Member

jku commented May 10, 2021

The idea of linking from git to a an older git commit seems fishy to me: Either we want to keep the papers somewhere or we don't.

I wonder if the papers would be a better fit for https://github.com/theupdateframework/specification/ repo?

@rzr
Copy link
Contributor Author

rzr commented May 10, 2021

yes That's what I suggested about relocating elsewhere,
It perfectly makes sense to have them in "specification"
because those files are statics and not tied to sources.
theupdateframework/specification#159

BTW This spec folder can also be packaged for debian unfree if there is any need.

Let me open a PR in spec repo to import theses PDFs and crosslink to this issue.

theupdateframework/specification#160

@rzr rzr changed the title docs: Remove academics files DRAFT: docs: Remove academics files May 10, 2021
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Move all files up one directory from 'src/'.

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@abf0349
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Refactored test_replay_attack.py,
changes to test_system_setup.py and renamed one of the docs.

Author: Kon <[email protected]>
Origin: theupdateframework/python-tuf@bb059cd
Relate-to: theupdateframework/python-tuf#1380
URL theupdateframework#159
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
…8.pdf

This change is part is of tuf's commit:

Removed doc duplicate and an obsolete test module.

Author: Kon <[email protected]>
Origin: theupdateframework/python-tuf@bb059cd
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Diplomat paper

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@e943048
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Mercury paper and entry in README.rst

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@fb9aa3e
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Move all files up one directory from 'src/'.

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@abf0349
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Refactored test_replay_attack.py,
changes to test_system_setup.py and renamed one of the docs.

Author: Kon <[email protected]>
Origin: theupdateframework/python-tuf@bb059cd
Relate-to: theupdateframework/python-tuf#1380
URL theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
…8.pdf

This change is part is of tuf's commit:

Removed doc duplicate and an obsolete test module.

Author: Kon <[email protected]>
Origin: theupdateframework/python-tuf@bb059cd
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Diplomat paper

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@e943048
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Mercury paper and entry in README.rst

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@fb9aa3e
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
…8.pdf

This change is part is of tuf's commit:

Removed doc duplicate and an obsolete test module.

Author: Kon <[email protected]>
Origin: theupdateframework/python-tuf@e7c4352
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Diplomat paper

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@e943048
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
rzr pushed a commit to rzr/specification that referenced this pull request May 10, 2021
This change is part is of tuf's commit:

Add Mercury paper and entry in README.rst

Author: vladdd <[email protected]>
Origin: theupdateframework/python-tuf@fb9aa3e
Relate-to: theupdateframework/python-tuf#1380
URL: theupdateframework#159
Forwarded: theupdateframework#160
Signed-off-by: Philippe Coval <[email protected]>
@joshuagl
Copy link
Member

Even if we continue to include the PDFs in this repository, we should not include them in the Python packaging either.

My preference would be that we just keep the PDFs on the website (theupdateframework/theupdateframework.io) and not in the spec or here.

@rzr
Copy link
Contributor Author

rzr commented May 10, 2021

Yes duplication it source of confusion, I'll update links

Duplication is not needed since files are hosted in website project:

https://github.com/theupdateframework/theupdateframework.io/tree/master/static/papers

Those generated files are not explicitly under Apache-2.0 licence
and AFAIK they can not be regenerated from missing (latex?) sources.

To avoid licence mixup.
It would help to have those files published elsewhere.
Meanwhile online (Github) links are used.

Debian had to repack the source package to make tarball compliant with DFSG
despite debian tools are known to be trustworthy,
this extra step would add weakess in the chain of trust

Cleanup done upstream would make distribution safer.

Bug: theupdateframework#1161
Bug-Debian: https://salsa.debian.org/python-team/packages/tuf/-/merge_requests/11
Relate-to: theupdateframework#263 (comment)
Forwarded: theupdateframework#1380
Relate-to: theupdateframework/specification#160
Signed-off-by: Philippe Coval <[email protected]>
@rzr rzr force-pushed the sandbox/rzr/review/master branch from 6f60cec to a79fd90 Compare May 10, 2021 12:56
@rzr rzr changed the title DRAFT: docs: Remove academics files docs: Remove academics files May 24, 2021
Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this change @rzr !

Any objections @mnm678, @trishankatdatadog ?

@trishankatdatadog
Copy link
Member

Sigh, missed opportunity to install our papers on millions of Debian computers...

@trishankatdatadog trishankatdatadog merged commit f496c83 into theupdateframework:develop May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants