Skip to content

Reorganize cloudprem docs#33776

Closed
fmassot wants to merge 130 commits intomasterfrom
fmassot/cloudprem-reorg
Closed

Reorganize cloudprem docs#33776
fmassot wants to merge 130 commits intomasterfrom
fmassot/cloudprem-reorg

Conversation

@fmassot
Copy link
Copy Markdown
Contributor

@fmassot fmassot commented Jan 9, 2026

What does this PR do? What is the motivation?

Reorganize cloudprem docs

@fmassot fmassot requested a review from a team as a code owner January 9, 2026 19:58
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 9, 2026

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Renamed files

Modified Files

@iadjivon
Copy link
Copy Markdown
Contributor

iadjivon commented Jan 9, 2026

Added Jira card for editorial review: https://datadoghq.atlassian.net/browse/DOCS-13082

@iadjivon iadjivon added the editorial review Waiting on a more in-depth review label Jan 9, 2026
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jan 12, 2026
@fmassot fmassot force-pushed the fmassot/cloudprem-reorg branch from 7a0291b to 36fd4d6 Compare January 13, 2026 09:41
@fmassot
Copy link
Copy Markdown
Contributor Author

fmassot commented Jan 14, 2026

Adding some remarks to improve the PR:

  • AWS and Azure install pages are quite long. Putting at the beginning links to the install section directly can be useful.
  • Move the network page to the configure folder and refactor it. We should focus on network configuration, not on describing the reverse connection. We could talk about the reverse connection by adding a new page in the introduction folder.
  • on the home page, we should start with a short paragraph describing what CloudPrem is, remove the image and add a page "What is CloudPrem" in the introduction folder.

@estherk15 what do you think?

Copy link
Copy Markdown
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

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

Thanks for the reorg, I added an alias to the pages that were moved. I left some comments on links, let me know if you have any questions.

Comment thread content/en/cloudprem/_index.md Outdated
Comment thread content/en/cloudprem/operate/troubleshooting.md
Comment thread content/en/cloudprem/configure/activate_cloudprem.md Outdated
Comment thread content/en/cloudprem/configure/activate_cloudprem.md Outdated
Comment thread config/_default/menus/main.en.yaml
Comment thread content/en/cloudprem/operate/search_logs.md
Comment thread content/en/cloudprem/install/aws_eks.md Outdated
Comment thread content/en/cloudprem/install/azure_aks.md Outdated
fmassot and others added 4 commits January 16, 2026 10:48
Co-authored-by: Esther Kim <esther.kim@datadoghq.com>
Co-authored-by: François Massot <francois.massot@gmail.com>
Comment thread content/en/cloudprem/operate/search_logs.md
Comment on lines +3 to +4
aliases:
- /cloudprem/introduction/network/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
aliases:
- /cloudprem/introduction/network/

Comment on lines +3 to +4
aliases:
- /cloudprem/configure/ingress/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
aliases:
- /cloudprem/configure/ingress/

Comment thread content/en/cloudprem/introduction/architecture.md Outdated
estherk15 and others added 10 commits January 16, 2026 09:29
* move removal content from service override page into service override removal doc

* add screenshots, copy refinements

* tweak final secxtion

* edit call-out to removal page on the service overrides guide page

* Update content/en/tracing/guide/service_overrides.md

Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>

* flesh out first paragraph

* move service override removal page

* title tweak for consistency with other pages

* change title of page reference

---------

Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
…#32964)

* Add troubleshooting case for workflows:write issue with GH

* Consolidate sections

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

* Copy improvements

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

* Update GH troubleshooting steps with recommendation from SCI

* Update content/en/bits_ai/bits_ai_dev_agent/setup.md

* Apply suggestions from code review

---------

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
* firs tpush

* update desc slightly

* add aliases

* Light copy update

* Add screenshot

* crop image

* Update content/en/data_observability/_index.md

Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>

---------

Co-authored-by: Kevin Hu <kevin.hu@datadoghq.com>
Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
* Remove Action Interface from the docs

* Revert "Remove Action Interface from the docs"

This reverts commit 767731a.

* Add alias for Action Interface

* Remove Action Interface file & folder

* Remove link to Actions Interface from page

* Remove Action Interface from sidebar
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
* restructure advanced notifications

* typo

* formatting
barboraplasovska and others added 9 commits January 16, 2026 09:29
* Add documentation for GraphQL iOS

* Fix: link

* Fix: update v2 configuration

* Fix: use info alert

* Apply PR suggestions

* Fix indentation

* Update content/en/real_user_monitoring/application_monitoring/ios/advanced_configuration.md

Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>

* Fix: datadog doesnt add headers

---------

Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
* Translated file updates

* fix corrupted syntax

---------

Co-authored-by: webops-guacbot[bot] <214537265+webops-guacbot[bot]@users.noreply.github.com>
Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com>
…api/v2/metrics endpoint (#33918)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
* Sync LLM Observability API documentation with Go implementation

Synced POST /api/intake/llm-obs/v1/trace/spans endpoint documentation with the Go source code implementation.

## Summary

- **128 applicable changes** applied (138 total, 10 internal fields excluded)
- **119 fields added** from Go implementation
- **11 fields removed/restructured** (metrics conversion)
- **4 type mismatches fixed**

## Changes by Section

### Span
- Added `service` field for service identification
- Added `ml_app` field (can override top-level value)
- Updated `metrics` type from structured object to `Dict[key (string), float64]`

### Meta
- Added `model_name`, `model_provider`, `model_version` for LLM model metadata
- Added `embedding_for_prompt_idx` for embedding computation tracking
- Added `span` field ([SpanField](#spanfield))
- Added `tool_definitions` array for available tools
- Added `expected_output` for expected output structure
- Added `intent` field for span intent

### IO (Input/Output/ExpectedOutput)
- Fixed array notation for `messages` and `documents` (added brackets)
- Added `embedding` field for embedding vectors
- Added `parameters` field for additional parameters

### Message
- Added `tool_calls` array ([ToolCall](#toolcall))
- Added `tool_results` array ([ToolResult](#toolresult))

### Document
- Added `ranking` field for document ranking
- Added `metadata` field for additional metadata

### Prompt
- Added `name` field for human-readable prompt name

### Metrics
- Converted from structured object with specific fields to generic dictionary
- Updated description to list common metric names as guidance
- Added `Type: Dict[key (string), float64]` specification

### New Type Definitions
- Added **ToolCall** section (4 fields: name, arguments, tool_id, type)
- Added **ToolResult** section (4 fields: name, result, tool_id, type)
- Added **ToolDefinition** section (3 fields: name, description, schema)
- Added **SpanField** section (1 field: kind)

## Internal Fields Excluded
The following internal fields were found in Go but excluded from documentation (10 fields):
- `_dd` object and its children
- `_dd_context_variable_keys` and `_dd_query_variable_keys` in Prompt

## Fields NOT Changed
The following fields remain as-is per existing documentation standards:
- Required markers (`[*required*]`) preserved on: data, data.type, data.attributes, meta.kind, messages.content
- Prompt `variables` and `tags` remain as `Dict[key (string), string]`
- `ml_app_version` intentionally not documented (deprecated field)

🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Update content/en/llm_observability/instrumentation/api.md

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
* [DOCS-12864] Add OCI billing guide

* [DOCS-12864] Address Vale warnings

* [DOCS-12864] Fix menu entry

* [DOCS-12864] Update page title

* Add log exclusion info

* Clarify data exclusion options
@estherk15 estherk15 requested review from a team as code owners January 16, 2026 14:30
@github-actions github-actions Bot added Github Related to Github configurations Images Images are added/removed with this PR Guide Content impacting a guide FAQ Content impacting a FAQ labels Jan 16, 2026
@github-actions github-actions Bot removed Github Related to Github configurations Images Images are added/removed with this PR Guide Content impacting a guide FAQ Content impacting a FAQ labels Jan 16, 2026
@estherk15
Copy link
Copy Markdown
Contributor

Sorry I messed up the PR with a rebase. I cherry picked the commits to a new PR: #33932

After the checks pass, I'll merge manually. This is good to go

@estherk15 estherk15 closed this Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.