Skip to content

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

Merged
shmsr merged 6 commits into
mainfrom
bacherol-patch-1
Nov 4, 2024
Merged

packages/salesforce: Update docs to reflect the use of optional security token#11512
shmsr merged 6 commits into
mainfrom
bacherol-patch-1

Conversation

@bacherol

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

Copy link
Copy Markdown

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 Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Oct 24, 2024
@shmsr shmsr changed the title Update README.md Oct 25, 2024
@shmsr

shmsr commented Oct 25, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

@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 reviewed Oct 25, 2024
View reviewed changes
Comment thread packages/salesforce/_dev/build/docs/README.md Outdated
@shmsr
shmsr requested a review from kush-elastic October 25, 2024 04:53
@elastic-vault-github-plugin-prod

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

Copy link
Copy Markdown
Contributor

🚀 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

@shmsr shmsr left a comment

Copy link
Copy Markdown
Member

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 Bot commented Oct 28, 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 28, 2024

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @bacherol
@shmsr

shmsr commented Oct 29, 2024

Copy link
Copy Markdown
Member

@bacherol If the changes looks good; let's merge the PR.
kush-elastic
kush-elastic approved these changes Oct 30, 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 651ee95 into main Nov 4, 2024
@shmsr
shmsr deleted the bacherol-patch-1 branch November 4, 2024 03:48
@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
Leandro de Lima Camargo @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-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 5, 2025
Leandro de Lima Camargo @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>
@andrewkroh andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:salesforce Salesforce Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

5 participants

@bacherol @shmsr @elasticmachine @kush-elastic @andrewkroh