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.

Sign up for GitHub

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

Jump to bottom

EDOT PHP documentation #144

Merged
merged 11 commits into from
Mar 28, 2025
Merged

EDOT PHP documentation #144

merged 11 commits into from
Mar 28, 2025
+572 −24

Conversation

intuibase
Copy link
Contributor

@intuibase intuibase commented Mar 24, 2025 •
edited
Loading

@intuibase intuibase self-assigned this Mar 24, 2025
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 46 36
✅ docs/_edot-sdks/php/release.md 64 54 25 80
✅ docs/_edot-sdks/php/setup/index.md 68 37 60 34
✅ docs/_edot-sdks/php/supported-technologies.md 66 55 31 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 77 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 46 36
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 68 39 56 37
✅ docs/_edot-sdks/php/supported-technologies.md 66 55 31 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 77 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 46 36
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 38 47 35
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 47 36
✅ docs/_edot-sdks/php/migration.md 63 31 35 34
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 38 47 35
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@intuibase intuibase requested a review from AlexanderWert March 25, 2025 13:56
@intuibase intuibase marked this pull request as ready for review March 25, 2025 13:56
@intuibase intuibase changed the title [DRAFT] EDOT PHP documentation EDOT PHP documentation Mar 25, 2025
@intuibase
Copy link
Contributor Author

check-links job is failing but the links are valid - verified locally

@intuibase
Copy link
Contributor Author

after merge I'll update documentation in agent repository and references in code and logs (to get valid links)

hegerchr
hegerchr requested changes Mar 26, 2025
View reviewed changes
Copy link
Contributor

@hegerchr hegerchr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the docs! Overall it's good to read and to follow. I have left comments to make the reading experience consistent with the other EDOT SDKs.

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 47 36
✅ docs/_edot-sdks/php/migration.md 63 31 35 34
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 38 47 35
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 58 37 47 36
✅ docs/_edot-sdks/php/migration.md 63 31 35 34
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 38 47 35
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 41 50 36
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@intuibase intuibase requested a review from hegerchr March 26, 2025 13:06
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 67 41 50 36
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@AlexanderWert
Copy link
Member

@intuibase please fix the broken links, see here: https://github.com/elastic/opentelemetry/actions/runs/14084087789/job/39443544072?pr=144

Please also see some notes on how to link internally within the docs pages: https://github.com/elastic/opentelemetry/tree/main/dev-docs#linking-other-pages

AlexanderWert
AlexanderWert reviewed Mar 26, 2025
View reviewed changes
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@intuibase intuibase requested a review from AlexanderWert March 26, 2025 14:54
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 23
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@intuibase intuibase requested a review from AlexanderWert March 26, 2025 19:52
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 24
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)		 Words + phrases
(Brand, terms)		 Correctness
(Spelling, grammar)		 Clarity
(Readability)
✅ docs/_edot-sdks/php/configuration.md 67 47 52 30
✅ docs/_edot-sdks/php/faq.md 100 100 100 100
✅ docs/_edot-sdks/php/index.md 60 35 52 34
✅ docs/_edot-sdks/php/migration.md 63 31 36 35
✅ docs/_edot-sdks/php/release.md 63 17 9 17
✅ docs/_edot-sdks/php/setup/index.md 71 38 63 34
✅ docs/_edot-sdks/php/setup/limitations.md 59 23 40 19
✅ docs/_edot-sdks/php/supported-technologies.md 65 43 34 24
✅ docs/_edot-sdks/php/troubleshooting.md 65 27 76 27

*TBD

@hegerchr hegerchr merged commit 6132c24 into elastic:main Mar 28, 2025
4 checks passed
@intuibase intuibase deleted the php_docs branch March 28, 2025 09:09
@intuibase intuibase mentioned this pull request Mar 28, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hegerchr hegerchr

@SergeyKleyman SergeyKleyman

@AlexanderWert AlexanderWert

Assignees

@intuibase intuibase

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@intuibase @elastic-acrolinx @AlexanderWert @hegerchr