Multi-file add-on installation process unclear #88147

New Issue

Johannes Schmitz · 2021-05-09T14:46:46+02:00

Johannes Schmitz commented

2021-05-09 14:46:46 +02:00

Pagename: editors/preferences/addons
Blender Version: 2.92
Documentation Language: en
Permanent link

Short description of error
I wanted to make a pull request but this seems to be in an old SVN Repo and a long way to get access to help contributing... so taking this way:

The page about add-ons says

3rd Party Add-ons

There are hundreds of add-ons that are not distributed with Blender and are developed by others. To add them to the list of other add-ons, they must be installed into Blender.

To install these, use the Install… button and use the File Browser to select the .zip or .py add-on file.

To a new user/developer it remains unclear that multi-file add-ons can only be installed throught the .zip mechanism. It is not possible to select a directory with files when using the install feature. Trying to install a multi-file add-on by selecting all of its files in the file selector GUI fails without error.

So a sentence should be added that states something like:

"Two types of add-ons exists, single and multi-file addons. Multi-file add-ons are installed as a .zip bundle, whereas for single file add-ons the respective .py file can be installed directly."

Alternatively the install mechanism could be fixed to allow selecting directories.

Pagename: `editors/preferences/addons` Blender Version: `2.92` Documentation Language: `en` [Permanent link ](https://docs.blender.org/manual/en/2.92/editors/preferences/addons.html) **Short description of error** I wanted to make a pull request but this seems to be in an old SVN Repo and a long way to get access to help contributing... so taking this way: The page about add-ons says > **3rd Party Add-ons** > > There are hundreds of add-ons that are not distributed with Blender and are developed by others. To add them to the list of other add-ons, they must be installed into Blender. > > To install these, use the Install… button and use the File Browser to select the .zip or .py add-on file. To a new user/developer it remains unclear that multi-file add-ons can only be installed throught the .zip mechanism. It is not possible to select a directory with files when using the install feature. Trying to install a multi-file add-on by selecting all of its files in the file selector GUI fails without error. So a sentence should be added that states something like: "Two types of add-ons exists, single and multi-file addons. Multi-file add-ons are installed as a .zip bundle, whereas for single file add-ons the respective .py file can be installed directly." Alternatively the install mechanism could be fixed to allow selecting directories.

Johannes Schmitz commented

2021-05-09 14:46:46 +02:00

Added subscriber: @johschmitz

Aaron Carlisle commented

2021-05-09 17:36:00 +02:00

Added subscriber: @Blendify

Aaron Carlisle commented

2021-05-09 17:36:00 +02:00

I wanted to make a pull request but this seems to be in an old SVN Repo and a long way to get access to help contributing... so taking this way:

What hurdles are you facing that make it hard? We want to make it easier to contribute so it would be nice to here what exactly people are having an issue with.

> I wanted to make a pull request but this seems to be in an old SVN Repo and a long way to get access to help contributing... so taking this way: What hurdles are you facing that make it hard? We want to make it easier to contribute so it would be nice to here what exactly people are having an issue with.

Johannes Schmitz commented

2021-05-09 18:24:57 +02:00

@Blendify I spent about half an hour trying to find out how I could fix the documentation and create some kind of pull request, then I gave up.

My expectations would be:

Users should be able to make a pull request without first contacting any core developer. A core developer or maintainer should then decide if the request can be merged, needs to be reworked or rejected.
Something as simple as a pull request to fix a typo in the documentation should not take longer than 5 minutes. 10 minutes including creating a new user account.

Maybe something similar is possible and I just did not find it? Currently I fail to see though how pull requests are technically possible with SVN at all.

@Blendify I spent about half an hour trying to find out how I could fix the documentation and create some kind of pull request, then I gave up. My expectations would be: - Users should be able to make a pull request without first contacting any core developer. A core developer or maintainer should then decide if the request can be merged, needs to be reworked or rejected. - Something as simple as a pull request to fix a typo in the documentation should not take longer than 5 minutes. 10 minutes including creating a new user account. Maybe something similar is possible and I just did not find it? Currently I fail to see though how pull requests are technically possible with SVN at all.

tintwotin commented

2021-05-09 19:12:50 +02:00

Added subscriber: @tintwotin

tintwotin commented

2021-05-09 19:12:50 +02:00

If someone bothers to deal with this Bf dev, here's a working patch which enables folder installation of add-ons: https://developer.blender.org/D9663

Aaron Carlisle commented

2021-05-12 23:23:31 +02:00

In #88147#1158241, @tintwotin wrote:
If someone bothers to deal with this Bf dev, here's a working patch which enables folder installation of add-ons: https://developer.blender.org/D9663

What is the reason this patch was abandoned?

In #88147#1158233, @johschmitz wrote:
@Blendify I spent about half an hour trying to find out how I could fix the documentation and create some kind of pull request, then I gave up.

My expectations would be:

Users should be able to make a pull request without first contacting any core developer. A core developer or maintainer should then decide if the request can be merged, needs to be reworked or rejected.

Something as simple as a pull request to fix a typo in the documentation should not take longer than 5 minutes. 10 minutes including creating a new user account.

Maybe something similar is possible and I just did not find it? Currently I fail to see though how pull requests are technically possible with SVN at all.

It is possible to submit a patch (PR) which is outlined here: https://docs.blender.org/manual/en/latest/about/contribute/patch_commit.html#submit-patches you also do not need to contact anyone to make a change.

I have made a post here: https://devtalk.blender.org/t/documentation-project-update/18808 outlining ways that we want to improve the contributing process, if you have ideas that are not listed in the post feel free to add a comment there.

> In #88147#1158241, @tintwotin wrote: > If someone bothers to deal with this Bf dev, here's a working patch which enables folder installation of add-ons: https://developer.blender.org/D9663 What is the reason this patch was abandoned? > In #88147#1158233, @johschmitz wrote: > @Blendify I spent about half an hour trying to find out how I could fix the documentation and create some kind of pull request, then I gave up. > > My expectations would be: > - Users should be able to make a pull request without first contacting any core developer. A core developer or maintainer should then decide if the request can be merged, needs to be reworked or rejected. > - Something as simple as a pull request to fix a typo in the documentation should not take longer than 5 minutes. 10 minutes including creating a new user account. > > Maybe something similar is possible and I just did not find it? Currently I fail to see though how pull requests are technically possible with SVN at all. It is possible to submit a patch (PR) which is outlined here: https://docs.blender.org/manual/en/latest/about/contribute/patch_commit.html#submit-patches you also do not need to contact anyone to make a change. I have made a post here: https://devtalk.blender.org/t/documentation-project-update/18808 outlining ways that we want to improve the contributing process, if you have ideas that are not listed in the post feel free to add a comment there.

tintwotin commented

2021-05-13 01:03:14 +02:00

@Blendify This was a quick fix patch, so I'm no going to spend my time on Campbell's shopping lists and whatever he makes up along the way.

Johannes Schmitz commented

2021-05-13 01:38:06 +02:00

If this can't be easily fixed maybe someone can at least add a single sentence to the documentation with an explanation: multiple files --> .zip?

Aaron Carlisle commented

2021-05-13 01:50:26 +02:00

In #88147#1160127, @johschmitz wrote:
If this can't be easily fixed maybe someone can at least add a single sentence to the documentation with an explanation: multiple files --> .zip?

Yes, I plan on doing that.

> In #88147#1160127, @johschmitz wrote: > If this can't be easily fixed maybe someone can at least add a single sentence to the documentation with an explanation: multiple files --> .zip? Yes, I plan on doing that.

Aaron Carlisle commented

2022-02-07 17:27:44 +01:00

Changed status from 'Needs Triage' to: 'Confirmed'