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]: Improve resources documentation #7705

Closed
2 tasks done
Badisi opened this issue Nov 16, 2021 · 5 comments
Closed
2 tasks done

[📖 Docs]: Improve resources documentation #7705

Badisi opened this issue Nov 16, 2021 · 5 comments
Labels
Docs 📖 Needs Triaging ⏳ No one has looked into the issue yet

Comments

@Badisi
Copy link
Contributor

Badisi commented Nov 16, 2021

Pre-check

  • I know I can edit the docs but prefer to file this issue

Describe the improvement

Unclear documentation

Description of the improvement / report

While looking for resources (plugins and such):

I don't know how but I'm sure there is something to do here to improve user adoption as it was painfull for me to find all those info.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Badisi Badisi added Docs 📖 Needs Triaging ⏳ No one has looked into the issue yet labels Nov 16, 2021
@christian-bromann
Copy link
Member

  • I first went to the github page and found this list:

This is a list of all packages that are part of this repository.

  • Then I went to the website and found this other list (which is not the same):

This is a general list of 3rd party plugins developed outside of this repository (community packages)

  • I also found this repo which I guess is used to generate the page on the website:

Correct!

Yes, this is indeed not well documented. Here is an example commit of someone adding their service/plugin to this list: 3cb5937.

@christian-bromann
Copy link
Member

@Badisi thanks for raising this issue. It is very important to be very clear about this to incentivise the community to build more plugins and make the WebdriverIO ecosystem richer. I added a commit to be more clear about this. Please review and let me know what you think. Happy to extend the docs further. Also let me know where else you see a lack of documentation. Thank you for your contributions!

@Badisi
Copy link
Contributor Author

Badisi commented Nov 22, 2021

All the 3rd-parties listed in services.json are only visible when using the wdio installer.
Maybe we could also list them in awesome-webdriverio ?

That way, people would be aware of that "rich ecosystem" even before starting using wdio.
And it could even make them adopt wdio if they see something that may fit their needs.

@christian-bromann
Copy link
Member

Maybe we could also list them in awesome-webdriverio ?

Yes, makes sense.

@Badisi
Copy link
Contributor Author

Badisi commented Nov 23, 2021

Done in webdriverio/awesome-webdriverio#4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 📖 Needs Triaging ⏳ No one has looked into the issue yet
Projects
None yet
Development

No branches or pull requests

2 participants