Skip to content

[APPSEC-57941] AAP Go exhaustive docs #30303

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eliottness
Copy link
Contributor

What does this PR do? What is the motivation?

This PR refactors the AAP Go documentation to be more exhaustive. The plan is to divide the docs in multiple pars:

  • The getting started detailing instructions to enable AAP via orchestrion and working around CGO issues
  • The dockerfile guide going step by step over a dockerfile building AAP and linking to a library of dockerfiles in appsec-go-test-app.
  • The compatibility docs mentioning:
    • The frameworks available and each dd-trace-go starting version.
    • go-libddwaf incompatibilities with CGO
    • What OS AAP is working under
  • SDK docs for users to increase their coverage where orchestrion work is still not done
  • Troubleshooting docs starting with known errors logs and each remediation available explaining issues encountered each time.

https://datadoghq.atlassian.net/browse/APPSEC-57941?atlOrigin=eyJpIjoiMzZjNjcyMWNhNTkxNGMzMmJlZjk3OTUxMWEyMjUyNTMiLCJwIjoiaiJ9

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@eliottness eliottness force-pushed the eliottness/exhaustive-doc branch from 75c474f to be24c61 Compare July 7, 2025 14:14
Copy link
Contributor

github-actions bot commented Jul 7, 2025

ℹ️ Documentation Team Review

No documentation team review is required for this pull request.

@eliottness eliottness changed the title Eliottness/exhaustive doc [APPSEC-57941] AAP Go exhaustive docs Jul 7, 2025
Copy link
Contributor

github-actions bot commented Jul 7, 2025

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

@eliottness eliottness force-pushed the eliottness/exhaustive-doc branch from be24c61 to 59b2293 Compare July 7, 2025 14:49
Copy link
Contributor Author

eliottness commented Jul 7, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

Signed-off-by: Eliott Bouhana <eliott.bouhana@datadoghq.com>
@eliottness eliottness force-pushed the eliottness/exhaustive-doc branch from 59b2293 to 582e02e Compare July 7, 2025 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant