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

[Synthetics] Document new Synthetics UI and user flows #2401

Closed
paulb-elastic opened this issue Nov 22, 2022 · 2 comments · Fixed by #2593
Closed

[Synthetics] Document new Synthetics UI and user flows #2401

paulb-elastic opened this issue Nov 22, 2022 · 2 comments · Fixed by #2593
Assignees
Labels
Area:Synthetics Synthetics Docs Issue Request:8.7 Team:Docs Label for the Observability docs team

Comments

@paulb-elastic
Copy link
Contributor

paulb-elastic commented Nov 22, 2022

Description

The new Synthetics UI has created a completely new set of reports, capabilities and UX for making the most of Synthetic tests (particularly browser based tests).

#2549 is the initial requirement for documenting the basics (and won’t be done until we’ve enabled the UI by default). After this is done, we can begin documenting these new flows.

This will likely take time, and doesn’t need to be done or ready for a particular stack release, but maybe worked on and released as the documentation becomes ready for each section as it’s done, once elastic/kibana#148969 has been released.

This will require collaboration with the team, especially D who can help position the use cases and main expected flows through the application.

Resources

The Synthetics UI has become much more capable in 8.7, but there are a lot of issues/PRs, it would not be useful to list them here.

We should collaborate on which flows, features and reports we want to document.

⚠️ We must be sure to include in the docs that the Synthetics UI does not support cross cluster search (CCS)

Collaboration

TBD. The docs and product team will work together to determine the best path forward.

Point of contact.

Main contact: @drewpost

Stakeholders:
@drewpost @paulb-elastic @andrewvc

@paulb-elastic paulb-elastic added Team:Docs Label for the Observability docs team Area:Synthetics Synthetics Docs Issue Request:8.6 Request:8.7 and removed Request:8.6 labels Nov 22, 2022
@colleenmcginnis colleenmcginnis self-assigned this Nov 22, 2022
@paulb-elastic
Copy link
Contributor Author

Updated the description as this was raised a little while ago.

@drewpost we'll need help from you to work with the docs team to plan out what we want documented and maybe a priority order for them to work from.

@drewpost
Copy link

Oh yes. This is going to be lots of fun. I'll coordinate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:Synthetics Synthetics Docs Issue Request:8.7 Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants