Skip to content

Conversation

shmsr
Copy link
Member

@shmsr shmsr commented Oct 7, 2025

Proposed commit message

Improve and update the documentation as per the latest Salesforce release. This PR also improves field descriptions.

Summary of changes:

  • Fix grammar and ensure consistent casing
  • Use backticks consistently (no asterisks)
  • Update content to be latest
  • Add authentication mechanisms section and also fix sub headings
  • Fix minor bugs
  • Improve field descriptions for clarity
  • Restructure with better headings/sub-headings
  • Add more Salesforce official links related to auth, deprecation notice, change in steps, etc.
  • Documentation now follows the new documentation guidelines

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 requested a review from a team as a code owner October 7, 2025 20:26
@shmsr shmsr requested a review from Copilot October 7, 2025 20:26
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Salesforce integration documentation to reflect the latest Winter '26 (v65.0) release and improves field descriptions throughout the package. The changes modernize authentication guidance and enhance clarity for users.

Key changes:

  • Updated compatibility information from Spring '22/Summer '24 to Winter '26 (v65.0)
  • Enhanced authentication documentation with clearer JWT bearer and Username-Password flow instructions
  • Improved field descriptions across data streams for better clarity and consistency

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/salesforce/docs/README.md Updated version compatibility, enhanced authentication methods documentation, improved field descriptions
packages/salesforce/_dev/build/docs/README.md Mirror of main README updates for build documentation
packages/salesforce/data_stream/setupaudittrail/manifest.yml Improved configuration field descriptions
packages/salesforce/data_stream/setupaudittrail/fields/fields.yml Enhanced field descriptions for better clarity
packages/salesforce/data_stream/logout/manifest.yml Improved configuration field descriptions
packages/salesforce/data_stream/logout/fields/fields.yml Enhanced field descriptions and corrected terminology
packages/salesforce/data_stream/login/manifest.yml Improved configuration field descriptions
packages/salesforce/data_stream/login/fields/fields.yml Enhanced field descriptions for consistency
packages/salesforce/data_stream/apex/manifest.yml Improved configuration field descriptions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@shmsr shmsr requested review from Linu-Elias and Copilot October 7, 2025 21:11
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@shmsr shmsr self-assigned this Oct 7, 2025
@shmsr shmsr added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Oct 7, 2025
The last entry in the list indicates the current version of your Salesforce instance. In this example, the current version is `Summer '22 (v55.0)`.
The last entry in the list indicates the current version of your Salesforce instance. In this example, the current version is `Winter '26 (v65.0)`.

## What do I need to use this integration?
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the section heading should be What do I need to use this integration? as mentioned in the documentation guidelines

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. Updated the docs to follow these new guidelines. Updated other sections as well.

@andrewkroh andrewkroh added Integration:salesforce Salesforce Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Oct 8, 2025
@elasticmachine
Copy link

elasticmachine commented Oct 8, 2025

💔 Build Failed

Failed CI Steps

History

cc @shmsr

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@alaudazzi
Copy link
Contributor

@shmsr the new structure looks good 👍

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. Integration:salesforce Salesforce Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants