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

packages/salesforce: Update docs to reflect the use of optional security token #11512

Merged
merged 6 commits into from
Nov 4, 2024
Merged

packages/salesforce: Update docs to reflect the use of optional security token #11512

merged 6 commits into from
Nov 4, 2024

Conversation

bacherol
Copy link
Contributor

@bacherol bacherol commented Oct 24, 2024 •
edited by shmsr
Loading

Proposed commit message

It seems when SF instance demands a security token, it should be added to the password field.

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

@bacherol bacherol requested a review from a team as a code owner October 24, 2024 21:02
@andrewkroh andrewkroh added Integration:salesforce Salesforce Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Oct 24, 2024
@shmsr shmsr changed the title Update README.md packages/salesforce: Update docs to reflect the use of optional security token Oct 25, 2024
@shmsr
Copy link
Member

shmsr commented Oct 25, 2024 •
edited
Loading

@bacherol This is how README edits are done:

Make modifications to: */_dev/build/docs/README.md and then run elastic-package build so that updated README gets generated for docs/README.md. If done the other i.e., changing docs/README.md and then running elastic-package build it'd result in no change to both as the reference is */_dev/build/docs/README.md for elastic-package build.

I've also updated the field's description.

Also, a changelog entry is required with a version change in root manifest.yml so that updated doc reflects in next patch upgrade. You can take a look at packages/salesforce/changelog.yml and packages/salesforce/manifest.yml. Let me know, if any help is required.

@shmsr shmsr requested a review from kush-elastic October 25, 2024 04:53
@elastic-vault-github-plugin-prod
Copy link

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@shmsr shmsr added docs enhancement New feature or request labels Oct 25, 2024
shmsr
shmsr approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@shmsr shmsr left a comment

Choose a reason for hiding this comment

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

I've added the CHANGELOG entry to go with 1.0.0 (GA). So, the changes won't be available until 8.16 stack release. If we 2 more PRs that are scheduled to go in with this 1.0.0 release of Salesforce; so added an entry there itself.

@elastic-sonarqube Elastic SonarQube
Copy link

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
Copy link

💚 Build Succeeded

History

cc @bacherol

@shmsr
Copy link
Member

shmsr commented Oct 29, 2024

@bacherol If the changes looks good; let's merge the PR.

kush-elastic
kush-elastic approved these changes Oct 30, 2024
View reviewed changes
Copy link
Collaborator

@kush-elastic kush-elastic left a comment

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 651ee95 into main Nov 4, 2024
5 checks passed
@shmsr shmsr deleted the bacherol-patch-1 branch November 4, 2024 03:48
@elastic-vault-github-plugin-prod
Copy link

Package salesforce - 1.0.0 containing this change is available at https://epr.elastic.co/package/salesforce/1.0.0/

harnish-elastic pushed a commit to harnish-elastic/integrations that referenced this pull request Feb 4, 2025
@bacherol @shmsr
packages/salesforce: Update docs to reflect the use of optional secur…
c33df3f 
…ity token (elastic#11512)

* Update docs

---------

Co-authored-by: subham sarkar <subham.sarkar@elastic.co>
harnish-elastic pushed a commit to harnish-elastic/integrations that referenced this pull request Feb 5, 2025
@bacherol @shmsr
packages/salesforce: Update docs to reflect the use of optional secur…
ff201be 
…ity token (elastic#11512)

* Update docs

---------

Co-authored-by: subham sarkar <subham.sarkar@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shmsr shmsr shmsr approved these changes

@kush-elastic kush-elastic kush-elastic approved these changes

Assignees

@bacherol bacherol

Labels
docs enhancement New feature or request Integration:salesforce Salesforce Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bacherol @shmsr @elasticmachine @kush-elastic @andrewkroh