[editorial] Remove invalid URLs for Google Docs#5014
[editorial] Remove invalid URLs for Google Docs#5014carlosalberto merged 6 commits intoopen-telemetry:mainfrom
Conversation
…metry#4916) With declarative configuration stable (open-telemetry#4374), I propose adjusting the spec contribution process to be "declarative config first". **What this means:** If a spec PR is proposing changes to an SDK component's configuration surface area, it should include a reference to an PR against `opentelemetry-configuration` to propose corresponding changes to the declarative config schema. **Why this is important:** - Ensures spec PRs are evaluated holistically. The declarative config schema is on track to become a crucial cross-language user facing API for the whole project. Operators can't or don't want to modify source code to use the programmatic API, and env vars are insufficient for non-trivial setups. By doing this, we add UX evaluation criteria in addition to the existing conceptual criteria. - Ensures declarative config schema stays in sync with the spec. - Helps drive consistency across language implementations, since its much harder to misinterpret / reinterpret a feature when there's a config schema spec to adhere to. - Further incentivizes the remaining languages to implement declarative config, helping the project achieve its mission of [telemetry concepts being universal across languages](https://opentelemetry.io/community/mission/#telemetry-should-be-universal). cc @open-telemetry/configuration-approvers Signed-off-by: Vitor Vasconcellos <vvasconcellos1@gmail.com>
Signed-off-by: Vitor Vasconcellos <vvasconcellos1@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR addresses link-check failures caused by non-public Google Docs links in the Logs data model documentation by removing those invalid URLs from the spec and the related OTEP.
Changes:
- Removed invalid Google Docs reference links from
specification/logs/data-model.md. - Removed invalid Google Docs links (and the now-empty References section) from
oteps/logs/0097-log-data-model.md. - Reformatted the Table of Contents in
specification/logs/data-model.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
specification/logs/data-model.md |
Removes broken Google Docs links from References and updates the page TOC formatting. |
oteps/logs/0097-log-data-model.md |
Removes broken Google Docs links (and associated References section) and reflows the Alternate Design text. |
Comments suppressed due to low confidence (1)
specification/logs/data-model.md:23
- The TOC format here differs from the rest of the spec docs: it now includes the page title (
Logs Data Model) and uses only-bullets, whereas other spec pages typically omit the first H1 and use the default markdown-toc bullet scheme. If TOCs are regenerated automatically, this is likely to cause unnecessary churn or mismatch. Consider regenerating with the same options used elsewhere (e.g.,markdown-toc --no-first-h1 -i) so the TOC starts at## Design Notesand matches the established bullet style.
- [Design Notes](#design-notes)
* [Requirements](#requirements)
* [Events](#events)
* [Field Kinds](#field-kinds)
- [Log and Event Record Definition](#log-and-event-record-definition)
* [Field: `Timestamp`](#field-timestamp)
* [Field: `ObservedTimestamp`](#field-observedtimestamp)
* [Trace Context Fields](#trace-context-fields)
+ [Field: `TraceId`](#field-traceid)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Vitor Vasconcellos <vvasconcellos1@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
arminru
left a comment
There was a problem hiding this comment.
Good reminder that next time we should probably retrieve a copy of the drafts and add them to the repo (or at least attach them in a Github comment on the PR) while the documents are still available.
…etry/opentelemetry-specification#5014) Signed-off-by: Vitor Vasconcellos <vvasconcellos1@gmail.com>
|
Maybe @tigrannajaryan remembers about that document (being the author of the Logs data model OTEP?). Otherwise not much we can do. Merging for now. |
I think it was created using a corporate account I no longer have access to. I don't think there is a way to recover it. |
The link was removed in open-telemetry#5014 I was able to locate a copy and created a new Google Doc with the same content.
The link was removed in #5014 I was able to locate a copy and created a new Google Doc with the same content.
Fixes #4812
Changes
Updates
oteps/logs/0097-log-data-model.mdandspecification/logs/data-model.mdby removing invalid Google Docs URLs, which were previously returning 401 and are now returning 404.