Skip to content

packages/salesforce: Improve docs and field descriptions - #11452

Merged
shmsr merged 8 commits into
elastic:mainfrom
shmsr:sf_doc_improvement
Oct 21, 2024
Merged

packages/salesforce: Improve docs and field descriptions#11452
shmsr merged 8 commits into
elastic:mainfrom
shmsr:sf_doc_improvement

Conversation

@shmsr

@shmsr shmsr commented Oct 17, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Proposed commit message

Improvements have been made to the current documentation by enhancing existing sections and adding new ones. More detailed explanations on configuration and troubleshooting errors have been included.

Field descriptions have also been improved. They now provide much more clarity on how to configure the integration.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices
@shmsr shmsr self-assigned this Oct 17, 2024
@shmsr shmsr added the Integration:salesforce Salesforce label Oct 17, 2024
@shmsr

shmsr commented Oct 17, 2024

Copy link
Copy Markdown
Member Author

Current it is in draft because I am looking for more areas of improvements. Aim is to improve docs for Salesforce as much as possible so that it is very smooth process for our users to install the Salesforce integration correctly.
shmsr
shmsr commented Oct 17, 2024
View reviewed changes
Comment thread packages/salesforce/_dev/build/docs/README.md

If you encounter data ingestion errors, you might get the following error message:

> oauth2 client: error loading credentials using user and password: oauth2: cannot fetch token: 400 Bad Request

@shmsr shmsr Oct 17, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

400 Bad Request can come in many forms. So omitting out the specifics.
@andrewkroh andrewkroh added the enhancement New feature or request label Oct 17, 2024
@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Oct 17, 2024

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport
@shmsr
shmsr marked this pull request as ready for review October 17, 2024 20:12
@shmsr
shmsr requested a review from a team as a code owner October 17, 2024 20:12
@andrewkroh andrewkroh added the Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] label Oct 17, 2024
alaudazzi
alaudazzi approved these changes Oct 18, 2024
View reviewed changes

@alaudazzi alaudazzi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I left a few editing suggestions. Otherwise LGTM.
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
shmsr and others added 3 commits October 18, 2024 23:31
@shmsr @alaudazzi
Apply suggestions from code review
31bdea0 
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@shmsr @alaudazzi
Update packages/salesforce/_dev/build/docs/README.md
bfd78d8 
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@shmsr
Address review comments
1f2aa94
@shmsr

shmsr commented Oct 18, 2024

Copy link
Copy Markdown
Member Author

@alaudazzi Thanks for reviewing. Appreciate the explanation for each suggestion. I've applied the changes.
shmsr
shmsr commented Oct 21, 2024
View reviewed changes
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
@elastic-sonarqube

elastic-sonarqube Bot commented Oct 21, 2024

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube
@elasticmachine

elasticmachine commented Oct 21, 2024

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @shmsr
kush-elastic
kush-elastic approved these changes Oct 21, 2024
View reviewed changes

@kush-elastic kush-elastic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!
@shmsr
shmsr merged commit 2bc360e into elastic:main Oct 21, 2024
@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Nov 13, 2024

Copy link
Copy Markdown
Contributor

Package salesforce - 1.0.0 containing this change is available at https://epr.elastic.co/package/salesforce/1.0.0/
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 4, 2025
@shmsr @alaudazzi
packages/salesforce: Improve docs and field descriptions (elastic#11452)
eba1698 
---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 5, 2025
@shmsr @alaudazzi
packages/salesforce: Improve docs and field descriptions (elastic#11452)
ee7efbc 
---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@shmsr
shmsr deleted the sf_doc_improvement branch February 6, 2025 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Integration:salesforce Salesforce Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

6 participants

@shmsr @elasticmachine @alaudazzi @kush-elastic @muthu-mps @andrewkroh