Open
Conversation
Contributor
|
|
nccatoni
force-pushed
the
nccatoni/doc
branch
from
667cd63 to
640f9bb
Compare
nccatoni
force-pushed
the
nccatoni/doc
branch
from
017f0d5 to
6ae139b
Compare
nccatoni
force-pushed
the
nccatoni/doc
branch
from
da5edf6 to
4f9b28c
Compare
This comment has been minimized.
This comment has been minimized.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The current documentation is not very beginner friendly and tend to be quite fragmented
Changes
docs/folder into a clearer structure with four top-level sections:understand/(concepts, scenarios, weblogs, architecture),execute/(running tests),edit/(writing tests), andCI/(integration)README.mdto serve as a proper landing page with quick start, output guide, and structured documentation linksdocs/understand/README.mdentry pointDetails
Root README rewrite
The root
README.mdwas restructured into a concise landing page:.,F,x,X,s) and what they mean, so newcomers can understand results immediatelywho-is-the-owner.md) directly into the READMEDirectory reorganization (32 file moves)
docs/scenarios/*docs/understand/scenarios/*docs/architecture/overview.mddocs/understand/architecture.mddocs/weblog/*docs/understand/weblogs/*docs/lib-injection/*.pngdocs/understand/images/*docs/internals/test-flow.mddocs/understand/test-flow.mddocs/internals/{agent,backend,library}-interface-*.mddocs/edit/*docs/internals/flushing.mddocs/edit/flushing.mdShort file consolidation (18 files deleted)
docs/internals/history.md(0 lines)docs/internals/README.md(inlined)docs/internals/requirements.md(1 line)docs/execute/skip-empty-scenario.md(3 lines)docs/execute/run.mddocs/execute/force-execute.md(6 lines)docs/execute/run.mddocs/execute/xfail-strict.md(11 lines)docs/execute/test-outcomes.mddocs/edit/troubleshooting.md(13 lines)docs/edit/README.md(logger) +docs/execute/troubleshooting.md(runtime)docs/internals/pytest.md(5 lines)docs/edit/README.mddocs/execute/dd-trace-debug.md(19 lines)docs/execute/troubleshooting.mddocs/edit/CI-and-scenarios.md(3 lines)docs/CI/system-tests-ci.mddocs/CI/gitlab-ci.md(13 lines)docs/CI/README.mddocs/scenarios/lifecycle.md(9 lines)docs/understand/scenarios/README.mddocs/scenarios/IPv6.md(5 lines)docs/understand/scenarios/README.mddocs/scenarios/go_proxies_envoy_haproxy.md(16 lines)docs/understand/scenarios/README.mddocs/internals/parametric-life-cycle.md(7 lines)docs/understand/scenarios/parametric.mddocs/scenarios/docker_fixtures.md(9 lines)docs/understand/scenarios/parametric.mddocs/internals/recreating_protobuf_files.md(4 lines)docs/internals/README.md(inlined)docs/ai/cursor-specialized-prompts.md(10 lines)docs/ai/ai-tools-integration-guide.mddocs/who-is-the-owner.md(11 lines)README.mdWorkflow
🚀 Once your PR is reviewed and the CI green, you can merge it!
🛟 #apm-shared-testing 🛟
Reviewer checklist
tests/ormanifests/is modified ? I have the approval from R&P teambuild-XXX-imagelabel is present