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

[Filebeat][Salesforce] Add Salesforce dashboard screenshots to documentation and add default input name in all the data-stream manifest #31796

Merged
merged 2 commits into from
Jun 8, 2022
Merged

[Filebeat][Salesforce] Add Salesforce dashboard screenshots to documentation and add default input name in all the data-stream manifest #31796

merged 2 commits into from
Jun 8, 2022

Conversation

kush-elastic
Copy link
Collaborator

@kush-elastic kush-elastic commented Jun 1, 2022 •
edited
Loading

  • Enhancement

What does this PR do?

Adds a screenshot of a dashboard to the documentation of the Salesforce filebeat module.
Adds default input name for config.yml to use (i.e. httpjson and cometd) in manifest.yml files of all the following data-streams.

Why is it important?

We had a discussion with @akshay-saraswat and it is important to have it in the documentation to pull it for press release.
data-stream config.yml expect input name as of integration test were added and now config.yml will need specific input name.

Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files

- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

Screenshots

filebeat-salesforce-login-dashboard
filebeat-salesforce-logout-dashboard

@kush-elastic kush-elastic requested a review from a team as a code owner June 1, 2022 12:11
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jun 1, 2022
@yug-rajani yug-rajani changed the title add salesforce dashboards screen shot to doc [Filebeat][Salesforce] Add Salesforce dashboard screenshots to documentation Jun 1, 2022
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 1, 2022 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-06T05:13:54.092+0000

  • Duration: 76 min 43 sec

Test stats 🧪

Test Results
Failed 0
Passed 6262
Skipped 737
Total 6999

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@mtojek mtojek added the Team:Docs Label for the Observability docs team label Jun 2, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/obs-docs (Team:Docs)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jun 2, 2022
dedemorton
dedemorton reviewed Jun 3, 2022
View reviewed changes
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

A couple minor edits. Why is there no doc preview for this PR?

x-pack/filebeat/module/salesforce/_meta/docs.asciidoc Outdated Show resolved Hide resolved
filebeat/docs/modules/salesforce.asciidoc Outdated Show resolved Hide resolved
@kush-elastic
Copy link
Collaborator Author

Why is there no doc preview for this PR?

I am not sure what you mean by doc preview. is there something I have do?
if there is anything missing please let me know.

@dedemorton
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs

@dedemorton
Copy link
Contributor

@kush-elastic The doc build should have run as part of the CI tests, but didn't. So I have submitted a command to run it.

@bmorelli25
Copy link
Member

Why is there no doc preview for this PR?

The PR author isn't a member of the Elastic GitHub org, so for security reasons the test has to be kicked off manually.

@kush-elastic
Copy link
Collaborator Author

@kush-elastic The doc build should have run as part of the CI tests, but didn't. So I have submitted a command to run it.

@dedemorton, thank you for the help.
if it seems good now, can we merge this PR?

@dedemorton dedemorton added backport-v8.3.0 Automated backport with mergify backport-v8.2.0 Automated backport with mergify labels Jun 8, 2022
dedemorton
dedemorton approved these changes Jun 8, 2022
View reviewed changes
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM. I assume we want to backport this to 8.2 and later, so I've added the backport tags. Thanks!

@dedemorton dedemorton merged commit b014528 into elastic:main Jun 8, 2022
@mergify mergify bot mentioned this pull request Jun 8, 2022
Closed
mergify bot pushed a commit that referenced this pull request Jun 8, 2022
@kush-elastic @mergify
[Filebeat][Salesforce] Add Salesforce dashboard screenshots to docume…
7bec531 
…ntation (#31796)

* add salesforce dashboards screen shot to doc

* change description

(cherry picked from commit b014528)

# Conflicts:
#	filebeat/docs/modules/salesforce.asciidoc
#	x-pack/filebeat/module/salesforce/_meta/docs.asciidoc
#	x-pack/filebeat/module/salesforce/login-rest/manifest.yml
#	x-pack/filebeat/module/salesforce/login-stream/manifest.yml
#	x-pack/filebeat/module/salesforce/logout-rest/manifest.yml
#	x-pack/filebeat/module/salesforce/logout-stream/manifest.yml
#	x-pack/filebeat/module/salesforce/setupaudittrail-rest/manifest.yml
mergify bot pushed a commit that referenced this pull request Jun 8, 2022
@kush-elastic @mergify
[Filebeat][Salesforce] Add Salesforce dashboard screenshots to docume…
6cbc672 
…ntation (#31796)

* add salesforce dashboards screen shot to doc

* change description

(cherry picked from commit b014528)
@mergify mergify bot mentioned this pull request Jun 8, 2022
Merged
@dedemorton
Copy link
Contributor

@ishleenk17 @lalit-satapathy My apologies. I should have waited for a review from someone on your team before merging this PR because it has changes to the manifest files. I haven't merged the backports yet, though. Can you take a look?

@kush-elastic kush-elastic changed the title [Filebeat][Salesforce] Add Salesforce dashboard screenshots to documentation [Filebeat][Salesforce] Add Salesforce dashboard screenshots to documentation and add default input name in all the data-stream manifest Jul 12, 2022
cmacknz pushed a commit that referenced this pull request Jul 22, 2022
@mergify @kush-elastic
[Filebeat][Salesforce] Add Salesforce dashboard screenshots to docume…
64e8428 
…ntation (#31796) (#31857)

* add salesforce dashboards screen shot to doc

* change description

(cherry picked from commit b014528)

Co-authored-by: Kush Rana <89848966+kush-elastic@users.noreply.github.com>
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@kush-elastic @chrisberkhout
[Filebeat][Salesforce] Add Salesforce dashboard screenshots to docume…
108ef0b 
…ntation (#31796)

* add salesforce dashboards screen shot to doc

* change description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dedemorton dedemorton dedemorton approved these changes

@ishleenk17 ishleenk17 Awaiting requested review from ishleenk17

@lalit-satapathy lalit-satapathy Awaiting requested review from lalit-satapathy

Assignees

@kush-elastic kush-elastic

Labels
backport-v8.2.0 Automated backport with mergify backport-v8.3.0 Automated backport with mergify :Dashboards Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kush-elastic @elasticmachine @dedemorton @bmorelli25 @mtojek