Page MenuHome

FIle downloads: re-evaluate
Open, NormalPublic

Description

We should re consider download files in the manual.

  • Should we have them?
  • Where should they be uploaded to?
    • Old files were on wiki.blender.org. should we move these to the new wiki?
    • Should these be in SVN then copied over during build?

Proposal:

I would like if we keep downloads and write some rules:

Must be CC-BY-SA 4.0 Int
Must be under 10mb for a zip
Files should be properly named with the blender version they were last updated for
Files are stored in the svn repo
A page should try limit itself to 1 example
blend-file should include a txt-file (opened in blender text editor) that describes the example and steps on how to use it.
All files should be stored as a zip
No py-files or other executable code (security reasons)

Details

Type
Bug

Event Timeline

Some remarks:

There are very useful examples files, such as for the Data Transfer Modifier.

Some examples are very simple and/or duplicated by screenshot or video, and can be removed.

And also there are old blend-files that don't work in new Blender versions, for example in the Physics section. There should be an opportunity to update them, if they remain in the manual.

Bastien Montagne (mont29) triaged this task as Normal priority.Aug 13 2018, 11:31 AM

I would like if we keep downloads and write some rules:

  • Must be CC-BY-SA 4.0 Int
  • Must be under 10mb for a zip
  • Files should be properly named with the blender version they were last updated for
  • Files are stored in the svn repo
  • A page should try limit itself to 1 example
  • blend-file should include a txt-file (opened in blender text editor) that describes the example and steps on how to use it.
  • All files should be stored as a zip
  • No py-files or other executable code (security reasons)

Anyone have any thoughts or concerns here?

Aaron Carlisle (Blendify) moved this task from Wiki to Backlog on the Documentation board.

Hi Aaron, I couldn't find this task when I searched for an existing one.

Replying to your questions:

I propose to put media files in the SVN repo for the manual under a new folder files/ in the root directory. Not in the new developer wiki.

  • Must be CC-BY-SA 4.0 Int

The files on the archived wiki were uploaded under the Open Content License or the Blender Artistic License.
The Blender Manual switched from OCL to CC-BY-SA 4.0.
I also wonder if the files should be re-uploaded with this license or keep one of the above?

  • Must be under 10mb for a zip.

I think we can recommend a maximum size, but I wouldn't strictly enforce it. 10MB seems low for media.

  • Files should be properly named with the blender version they were last updated for

Renaming would break links, I would not put the Blender version on the file name.
We could ask for .blend files to have a text buffer with the version, besides the license, but this would also mean bumping all binary files on every blender release.
Since the manual is now versioned, I think there is no need to manually add versions to the files. They still should be checked periodically, but that can be part of the release process checklist.

  • Files are stored in the svn repo

Yes.

  • A page should try limit itself to 1 example

I don't see the reason for this limitation.

  • blend-file should include a txt-file (opened in blender text editor) that describes the example and steps on how to use it.

A blend file (or a zip), should always have a text with the license and readme. However, I'd keep text to a minimum and refer to the manual page.

  • All files should be stored as a zip

I also don't see a reason for this limitation.

  • No py-files or other executable code (security reasons)

Python code may be needed as a demo, although most python examples are already shipped with Blender.
I wouldn't limit this either.

It's been some time without a reply.
@Sergey Sharybin (sergey) @Campbell Barton (campbellbarton) do you have anything against putting media files in the manual SVN under a new files/ folder in the root directory?

These are the only rules I would include:
Guidelines for Media Files

  • Files should be accompanied by a text stating its license and purpose. This text can be in a text buffer for a .blend file, or in a .txt inside a zip accompanying other files.

The license should be CC-BY-SA 4.0 or the original license for a pre-existing file. Do not submit content under an incompatible license or someone else's work without their permission.

This file is a part of the Blender Manual (https://docs.blender.org/manual) by the Blender Documentation Team
and it is licensed under CC-BY-SA v4.0 (https://creativecommons.org/licenses/by-sa/4.0).
  • Don't include information that is easily outdated. eg. Blender versions, dates and expressions such as "since last week" or "the new option". Versioning and history information can be extracted from SVN.
  • Name the file carefully and do not include a Blender version in the naming.
  • Check the size of the file before uploading, and if possible, minimize it.

@Inês Almeida (brita_), i am all for keeping things locally in terms where they belong to. Makes it easier to version, control consistency, and see where they actually are supposed to be put.

Not sure about such a strict rule about the license. Can one submit a public-domain things (images and diagrams describing/showing some algorithm)? How is that aligned with content of open movies and the blender cloud?

@Sergey Sharybin (sergey) why do you think the licensing rule is strict?
A public domain diagram of an algorithm can be uploaded with its original license and author if needed. I think public domain, other versions of CC and the licenses used in the previous Blender wiki are all perfectly fine.
The Blender Cloud says: "Unless notified otherwise, all digital content (webpages, video, artwork, 3D data) is available under the Creative Commons Attribution 4.0.". Blender Cloud textures are CC0. So these can also be uploaded with their original license.

The only thing you can't do is upload some proprietary thing which is then redistributed when its license doesn't allow it. Also re-licensing someone's work without their consent would be bad.

It seems easier not to use the .blend files in the manual at all. Тoo many problems.

  • not one of the current files will not work/look well in 2.8
  • license (contributor may upload something is not suitable)
  • security (py-files or other executable code)
  • and so on

There may be links to external files in the see more section, for example files from developers in release logs.