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] add link to clean elastic-package usage docs #1974

Closed
nicpenning opened this issue Jul 13, 2024 · 3 comments · Fixed by #1982
Closed

[docs] add link to clean elastic-package usage docs #1974

nicpenning opened this issue Jul 13, 2024 · 3 comments · Fixed by #1982
Labels
Team:Ecosystem Label for the Packages Ecosystem team

Comments

@nicpenning
Copy link
Contributor

nicpenning commented Jul 13, 2024

As a user of Elastic Package, I enjoy using this guide: https://www.elastic.co/guide/en/integrations-developer/current/elastic-package.html

This is referenced in the Elastic Integrations repo nicely.

Would there be any issues with referencing in the main Readme.md for this repo like this is? https://github.com/elastic/integrations/blob/main/CONTRIBUTING.md

I find myself going to that documentation as it is a but more user friendly. This could help others get jump started with building integrations and not be confused with the development of elastic-package itself.

Thoughts?

@nicpenning nicpenning changed the title [docs] add link to cleane elastic-package usage docs [docs] add link to clean elastic-package usage docs Jul 13, 2024
@jsoriano
Copy link
Member

Hey @nicpenning, nice suggestion, and happy to see you find the developers guide useful!
Feel free to open a PR with your suggestion, and we can discuss there.
Thanks!

@nicpenning
Copy link
Contributor Author

Sounds good, I will give it go!

@kpollich kpollich added the Team:Ecosystem Label for the Packages Ecosystem team label Jul 19, 2024
@nicpenning
Copy link
Contributor Author

QQ, what's the process for updating this project's readme? When I go to edit it says it is a generated file. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Ecosystem Label for the Packages Ecosystem team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants