Skip to content

Commit d9e16c5

Browse files
heiskrheiskr
authored
More docs-e cleanup (#62871)
1 parent f14de77 commit d9e16c5

8 files changed

Lines changed: 12 additions & 17 deletions

File tree

‎contributing/deployments.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
## Deployments
22

3-
Staging and production deployments are automated by a deployer service created and maintained by @github/docs-engineering.
4-
53
### Review deployments
64

75
TBD

‎src/assets/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ To request a resized version:
6161

6262
## Ownership
6363

64-
- **Team**: `@github/docs-engineering`
64+
- `#technical-content`
6565
- **Escalation**: If image serving fails or performance degrades, check the `dynamic-assets` middleware and `sharp` processing.
6666

6767
## Current State & Known Issues
6868

6969
- **On-the-fly Processing**: We currently process images on request (cached by CDN). This avoids a massive build-time step but requires CPU resources on the server for uncached requests.
70-
- **WebP**: We prefer WebP for performance but maintain PNGs as the source of truth.
70+
- **WebP**: We prefer WebP for performance but maintain PNGs as the source of truth.

‎src/color-schemes/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ This hook is primarily used at the root of the application (e.g., in `src/frame/
7171

7272
## Ownership
7373

74-
- **Team**: `@github/docs-engineering`
74+
- `#technical-content`
7575

7676
## Current State & Known Issues
7777

7878
- **Page background flash (fixed)**: The page-level theme (the `<html>` `data-*` attributes that drive the background color) is now set before first paint by the inline `colorModeScript`, so there is no longer a light-to-dark flash of the page background on load.
7979
- **Primer component theming**: Primer React components still resolve their theme from the post-hydration `useTheme` state, so component-level theming applies slightly after the page background. The `setTimeout` workaround below is still required for that path.
8080
- **Race Condition Workaround**: There is a `setTimeout` hack in `useTheme.ts` to delay the theme application. This is necessary to prevent Primer React's internal logic from overriding the user's preference with `auto` on initial load.
8181
- *Reference*: [Primer React Issue #2229](https://github.com/primer/react/issues/2229)
82-
- **Future**: The long-term goal is to rely entirely on CSS variables, removing the need for complex JavaScript state management for theming.
82+
- **Future**: The long-term goal is to rely entirely on CSS variables, removing the need for complex JavaScript state management for theming.

‎src/early-access/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ To work on Early Access content locally:
7070

7171
## Ownership
7272

73-
- **Team**: `@github/docs-engineering`
73+
- `#technical-content`
7474
- **Content Owners**: The Writers and Product Managers responsible for the specific early access features.
7575

7676
## Current State & Known Issues
7777

7878
- **"Hidden" but Public**: While the source is private, once deployed to `docs.github.com`, the pages are technically public if you know the URL. They are "security through obscurity" (hidden from nav/search), not authenticated.
79-
- **Build Complexity**: The merging process adds complexity to the build pipeline and can sometimes cause confusion with path resolution or asset loading if files are moved incorrectly.
79+
- **Build Complexity**: The merging process adds complexity to the build pipeline and can sometimes cause confusion with path resolution or asset loading if files are moved incorrectly.

‎src/links/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ See [`lib/README.md`](lib/README.md) for how to investigate and triage a broken
102102

103103
## Ownership
104104

105-
- **Team**: `@github/docs-engineering`
105+
- `#technical-content`
106106

107107
## Current State & Known Issues
108108

‎src/release-notes/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ The files in `data/release-notes` are the destination for this external data.
6060

6161
## Ownership
6262

63-
- **Team**: `@github/docs-engineering`
63+
- `#technical-content`
6464
- **Content Owners**: The Writers and Release Managers responsible for the GHES release process.
6565

6666
## Current State & Known Issues
6767

6868
- **Translation Workaround**: As mentioned, we currently force English rendering for release notes to avoid "over-translation" of product names. This is a known limitation until the source data is updated to use proper Liquid variables.
69-
- **Legacy Redirects**: The middleware handles redirects for very old versions (pre-2.20) to `enterprise.github.com`.
69+
- **Legacy Redirects**: The middleware handles redirects for very old versions (pre-2.20) to `enterprise.github.com`.

‎src/shielding/README.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ npm run test -- src/shielding/tests
9191
- [`src/observability`](../observability/README.md) - Logging suspicious traffic patterns
9292
- CDN configuration - Fastly edge rules
9393

94-
### Internal documentation
95-
For detailed discussion on resilience and availability improvements, see:
96-
- [How we have fortified Docs for better resiliency and availability (June 2023)](https://github.com/github/docs-engineering/discussions/3262)
94+
9795

9896
### Ownership
9997
- Team: Docs Engineering
@@ -165,4 +163,3 @@ CDN integration:
165163
- Check that redirects are followed
166164
- Analyze cache miss patterns
167165
- Coordinate with CDN configuration
168-

‎src/tools/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ npm run liquid-markdown-tables -- convert content/path/to/article.md
6262

6363
## Ownership
6464

65-
- **Team**: `@github/docs-engineering`
65+
- `#technical-content`
6666
- **Content Strategy**: The list of supported tools is maintained in collaboration with the Content team based on product requirements.
6767

6868
## Current State & Next Steps
6969

7070
- **Current State**: The tools and platforms picker module is stable and actively maintained. Core features are complete and in regular use across the site.
7171
- **Known Limitations**: Some legacy articles may not fully support picker functionality due to outdated Markdown or Liquid structures. Analytics integration is basic and may be expanded in the future.
72-
- **Next Steps**: Planned improvements include enhanced analytics reporting, better support for edge cases in content rendering, and ongoing collaboration with the Content team to add new tools and platforms as needed.
72+
- **Next Steps**: Planned improvements include enhanced analytics reporting, better support for edge cases in content rendering, and ongoing collaboration with the Content team to add new tools and platforms as needed.

0 commit comments

Comments
 (0)