lack of documentation for library developers (PACMAN-296)

[trombik]

The Component Manager version

N/A

ESP-IDF Version

N/A

python Version

N/A

Operating System

N/A

Browser (for https://components.espressif.com Issues)

N/A

Description

I could not find documentation for library developers.

contexts

I am a maintainer of esp-idf components at https://github.com/UncleRus/esp-idf-lib.

once @pedrominatel said espressif would help us but i've gotten none so far.

UncleRus/esp-idf-lib#260 (comment)

I am trying to understand how the component registry works, and evaluate how it is useful for us.

what I need to know

• how the registry works; the registration process, quality assurance (if any), verification of ownership, acceptable use policy, name space policy, etc.
• technical details: how to publish beta, snapshot, and releases, reference manual of metadata, integrity checks (SHA sum, or cryptographic signatures)

To Reproduce

N/A

Expected behaviour

espressif provides documentation for library developers.

Additional info

No response

I have checked existing issues and online Documentation

• I confirm I have checked existing issues and online Documentation.

[VojtechBartoska]

Hello @trombik,

first of all thank you for raising an issue and your interest in using Component Manager.

To clarify current situation, Component Manager was released recently and at this stage, it's only available for uploading internal (Espressif) components.

Due to this fact there is no option to upload 3rd party components, there is no documentation and so on.

To give you an update, we are now working on making upload available for everyone, when it's ready and released. It will contain all necessary information mentioned above.

We are looking forward for having esp-idf-lib in Component Manager service as @pedrominatel mentioned. :) I will keep this issue open so it will be reminder for us to track upload of esp-idf-lib library if you will be interested.

I hope it's clear now. If you have more questions, don't hesitate to ask.

[trombik]

@VojtechBartoska sounds great. thank you.

[kumekay]

@trombik We are in preview for 3rd party contributors, if you are interested, please fill the form https://components.espressif.com/preview/

[trombik]

@kumekay thanks. just signed up. i'll ask questions later.

[gojimmypi]

Hi @kumekay the 3rd party preview signup link is currently 404.

I'd like to add the wolfSSL component to the Espressif component registry. Per a discussion with @igrr and noted in espressif/esp-wolfssl#16 (comment) we'd like to move the esp-wolfssl repo and have a fresh, regularly maintained wolfSSL library.

Please let me know how best to proceed.

Thank you.

[kumekay]

Hello @gojimmypi

We have already removed the preview signup form and planning to release signup through Github in just a few days (I'm pretty sure it's going to happen this week)

To solve it even sooner, please get in touch with me at [email protected]

[gojimmypi]

Hi @kumekay that's awesome, thank you! email sent.

[gojimmypi]

Following up on this issue: the ESP Registry is really quite nice, the latest docs are very clear.

I have wolfSSL published at https://components.espressif.com/components/wolfssl/wolfssl

Thank you @kumekay for your help.

Heads up to others to beware of unicode or other non-UTF8 chars in README.md files.

This iconv command may be helpful to clean files:

    cat ./README_REGISTRY_PREPEND.md  ./README.md > ./NEW_README.md
    THIS_ENCODING=$(file -b --mime-encoding ./NEW_README.md)
    echo "Found encoding: $THIS_ENCODING"

    iconv  --to-code=UTF-8//ignore  --output=./README.md  "./NEW_README.md"

[trombik]

Hi,

When sign-in by GitHub OAuth, I've got:

User with name "trombik" already exists, probably it was created by another method. Please contact support.

Would you have a look?

[kumekay]

@trombik A few manually created preview users may see this. Could you please log in once again and ping me afterwards, so I'll check your permissions?

[trombik]

@kumekay thanks, successfully logged in. does the registry support organizations? like GitHub organization. Have a look at our use case at: UncleRus/esp-idf-lib#543

[trombik]

it's not clear to me but i guess i need my namespace?

Selected profile "default" from the idf_component_manager.yml config file
Saving archive to "/usr/home/trombik/github/trombik/esp-adf-component-ai-thinker-esp32-a1s/dist/adf-ai-thinker-esp32-a1s_0.0.1.tgz"
Uploading archive /usr/home/trombik/github/trombik/esp-adf-component-ai-thinker-esp32-a1s/dist/adf-ai-thinker-esp32-a1s_0.0.1.tgz
100%|██████████| 7.29k/7.29k [00:00<00:00, 33.7kB/s]
ERROR: You are not allowed to perform this action.

[trombik]

I need trombik namespace just like GitHub. Also, as a maintainer of esp-idf-lib, we will need another for our libraries. It would be nice to have a doc explaining how one can obtain and manage namespaces. In addition, how toke ACL works.

[kumekay]

Hi @trombik
I apologize for the confusion with your login through GitHub because we only had a few users before we introduced login through GitHub, we didn't invest enough efforts to the process of migration existing accounts.

Now you should see both trombik and esp-idf-lib namespaces in your profile.

Documentation about namespace management as well as namespace management itself is coming a bit later this August.

Note: the old token, you used before, continues to work until you revoke it, but it won't be visible in the panel.

[trombik]

@kumekay thanks a lot. I'll give it a try.

[kumekay]

Just a small update regarding this issue. You can manage permissions for components and namespaces on the profile page of the registry: https://components.espressif.com/users/me

As for now, namespaces not matching GitHub username are created on request via [email protected]

[kumekay]

We are continuously updating the documentation for the Component Manager here: https://docs.espressif.com/projects/idf-component-manager/en/latest/.

Additionally, we have launched a new series of blog posts with tutorials:
https://developer.espressif.com/tags/component/

While we will keep improving the documentation, I believe the main part of this task is now complete. You are welcome to share any topics you think are still missing.