[Logs UX] Developer guide - Onboarding docs

[gbamparop]

This issue aims to gather some information about the current state of dev documentation with regards to logs-related UIs with a goal to facilitate onboarding of new engineers and to act as a point of reference for the whole team. This is meant to be a living guide which is kept up-to-date.

These docs can link to other relevant information such as:

• Kibana developer guide
• Logs UX team structure and charter doc once it's moved to Github
• Observability-wide documentation (processes, dev docs etc)
• Logs Explorer code walkthrough recording

Proposed sections:

Local development

Local setup is covered by the Kibana developer guide but it would be good to link to the oblt-cli docs and also mention how synthetic logs data can be ingested in the cluster.

State management

Some resources are mentioned in the logs_explorer plugin while others in the infra plugin. Does it make sense to move them to a single place?

Testing

Types of tests, test locations and relevant commands, test coverage.

Telemetry

There is some documentation in the infra plugin. Is this still relevant?

Code deployment

How to deploy and test code in cloud and Serverless. (oblt cli, chrome plugin etc)

Learning / Additional resources

• Observability Fundamentals course
• Elastic Observability Engineer course
• Logs Overview (Observability docs)

Questions

• Where is the best place to host the docs (e.g. x-pack/plugins/logs_shared)? In addition, configuration can be added so they are included in the dev docs (see https://github.com/elastic/kibana/issues/94559)/

[achyutjhunjhunwala]

Good point about testing, it would be good to have all the commands handy and documented around

1. All tests - Unit, API and E2E, stateful and serverless
2. Checktypes
3. Linting

Do we have any Log Generator similar to Synthtrace which we were using in APM for generating Metrics and Traces ? Thinking more from API, E2E tests perspective and avoiding the usage of ES Snapshots