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.

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

[Connectors][ServiceNow ITOM] Edit required labels and automate screenshots #172229

Merged
merged 7 commits into from
Dec 4, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 30, 2023

Summary

This PR:

  • Updates the ServiceNow ITOM connector UI so that the "required" qualifier is subdued and separated from the field label
  • Fixes the capitalization of several field labels for the ServiceNow connectors
  • Automates three screenshots for the ServiceNow ITOM connector documentation, so that they're up-to-date
  • Sorts the list of configuration options alphabetically in the ServiceNow ITOM connector documentation and aligns the descriptions with what exists in the openAPI specification.
  • Moves the ServiceNow configuration steps to the end of the page, same as in other connector pages

NOTE: It seems like some connector UIs callout the "Required" fields while others callout the "Optional" fields. IMO we should follow the same strategy across all the connector UIs, so that users have consistent experience. However, I've not made that change in this PR.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework v8.12.0 labels Nov 30, 2023
Copy link
Contributor

Documentation preview:

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
stackConnectors 549.5KB 550.3KB +781.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl added v8.12.1 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed v8.12.0 backport:skip This commit does not require backporting labels Dec 4, 2023
@lcawl lcawl marked this pull request as ready for review December 4, 2023 18:00
@lcawl lcawl requested a review from a team as a code owner December 4, 2023 18:00
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@lcawl lcawl changed the title [DOCS] Automate ServiceNow ITOM connector screenshots [Connectors][ServiceNow ITOM] Edit required labels and automate screenshots Dec 4, 2023
Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl merged commit e69063e into elastic:main Dec 4, 2023
34 checks passed
@lcawl lcawl deleted the connector-optional-labels branch December 4, 2023 19:50
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 4, 2023
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.11

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Dec 4, 2023
…e screenshots (#172229) (#172516)

# Backport

This will backport the following commits from `main` to `8.11`:
- [[Connectors][ServiceNow ITOM] Edit required labels and automate
screenshots (#172229)](#172229)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-12-04T19:50:07Z","message":"[Connectors][ServiceNow
ITOM] Edit required labels and automate screenshots
(#172229)","sha":"e69063e08256b315175af9f749de762197537ca3","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","backport:prev-minor","v8.12.0","v8.12.1"],"number":172229,"url":"https://github.com/elastic/kibana/pull/172229","mergeCommit":{"message":"[Connectors][ServiceNow
ITOM] Edit required labels and automate screenshots
(#172229)","sha":"e69063e08256b315175af9f749de762197537ca3"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/172229","number":172229,"mergeCommit":{"message":"[Connectors][ServiceNow
ITOM] Edit required labels and automate screenshots
(#172229)","sha":"e69063e08256b315175af9f749de762197537ca3"}},{"branch":"8.12","label":"v8.12.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.11.2 v8.12.0 v8.12.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants