Skip to content

Commit e67e24b

Browse files
authored
[CI/i18n] Contrib docs update and hugo.yaml config cleanup (#8302)
1 parent 17bc6d1 commit e67e24b

File tree

7 files changed

+32
-265
lines changed

7 files changed

+32
-265
lines changed

.github/copilot-instructions.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ info here.
105105

106106
```
107107
.
108-
├── README.md # Project overview and contribution guidelines
109-
├── package.json # Node.js dependencies and npm scripts
110-
├── hugo.yaml # Hugo configuration with mounts and language settings
108+
├── README.md # Project overview and contribution guidelines
109+
├── package.json # Node.js dependencies and npm scripts
110+
├── config/**/*.yaml # Hugo configuration with mounts and language settings
111111
├── content/ # Main content (English and translations)
112112
├── content-modules/ # Git submodules for specifications and community docs
113113
├── layouts/ # Hugo templates and partial templates
@@ -168,13 +168,14 @@ npm run fix:markdown # Auto-fix markdown issues
168168
- Uses Hugo v0.148.2 with extended features
169169
- Theme: Docsy (Google's documentation theme)
170170
- Multilingual support enabled for 8+ languages
171-
- Content mounting from submodules defined in `hugo.yaml`
171+
- Content mounting from submodules defined in
172+
`config/_default/module-template.yaml`
172173
- Generated files placed in `public/` directory
173174

174175
### Frequently Accessed Files
175176

176177
- `package.json` - Dependencies and scripts
177-
- `hugo.yaml` - Site configuration and content mounts
178+
- `config/_default/*.yaml` - Site configuration and content mounts
178179
- `content/en/docs/contributing/development.md` - Development setup guide
179180
- `.warnings-skip-list.txt` - Known acceptable build warnings
180181
- `.cspell.yml` - Spell checking configuration

.github/localization.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ default_lang_commit: <commit-hash-of-english-page>
153153

154154
1. Create issue with localization request
155155
2. Translate homepage only: `content/LANG_ID/_index.md`
156-
3. Maintainers will update `hugo.yaml`, cSpell configuration, and create
156+
3. Maintainers will update Hugo config, cSpell configuration, and create
157157
language-specific tools
158158

159159
### Language-Specific Tooling

config/_default/hugo.yaml

Lines changed: 4 additions & 248 deletions
Original file line numberDiff line numberDiff line change
@@ -259,251 +259,7 @@ security:
259259
getenv: # cspell:disable-line
260260
# Netlify build env var
261261
- ^(BRANCH|BUILD_ID|COMMIT_REF|CONTEXT|DEPLOY_ID|NETLIFY|PULL_REQUEST|REVIEW_ID)$
262-
263-
module:
264-
mounts:
265-
## en
266-
- source: content/en
267-
target: content
268-
- source: tmp/community/mission-vision-values.md
269-
target: content/community/mission.md
270-
- source: tmp/community/roadmap.md
271-
target: content/community/roadmap.md
272-
# Specs, currently en only
273-
- source: tmp/otel/specification
274-
target: content/docs/specs/otel
275-
- source: tmp/opamp
276-
target: content/docs/specs/opamp
277-
- source: tmp/otlp/docs/specification.md
278-
target: content/docs/specs/otlp/_index.md
279-
- source: tmp/otlp/docs/img
280-
target: content/docs/specs/otlp/img
281-
# Semconv
282-
# cSpell:ignore cloudevents faas
283-
- source: tmp/semconv/docs
284-
target: content/docs/specs/semconv
285-
excludeFiles: '**/README.md'
286-
# DO NOT EDIT - semconv autogenerated mounts below - DO NOT EDIT
287-
- source: tmp/semconv/docs/app/README.md
288-
target: content/docs/specs/semconv/app/_index.md
289-
- source: tmp/semconv/docs/azure/README.md
290-
target: content/docs/specs/semconv/azure/_index.md
291-
- source: tmp/semconv/docs/browser/README.md
292-
target: content/docs/specs/semconv/browser/_index.md
293-
- source: tmp/semconv/docs/cicd/README.md
294-
target: content/docs/specs/semconv/cicd/_index.md
295-
- source: tmp/semconv/docs/cli/README.md
296-
target: content/docs/specs/semconv/cli/_index.md
297-
- source: tmp/semconv/docs/cloud-providers/README.md
298-
target: content/docs/specs/semconv/cloud-providers/_index.md
299-
- source: tmp/semconv/docs/cloudevents/README.md
300-
target: content/docs/specs/semconv/cloudevents/_index.md
301-
- source: tmp/semconv/docs/database/README.md
302-
target: content/docs/specs/semconv/database/_index.md
303-
- source: tmp/semconv/docs/dns/README.md
304-
target: content/docs/specs/semconv/dns/_index.md
305-
- source: tmp/semconv/docs/dotnet/README.md
306-
target: content/docs/specs/semconv/dotnet/_index.md
307-
- source: tmp/semconv/docs/exceptions/README.md
308-
target: content/docs/specs/semconv/exceptions/_index.md
309-
- source: tmp/semconv/docs/faas/README.md
310-
target: content/docs/specs/semconv/faas/_index.md
311-
- source: tmp/semconv/docs/feature-flags/README.md
312-
target: content/docs/specs/semconv/feature-flags/_index.md
313-
- source: tmp/semconv/docs/gen-ai/README.md
314-
target: content/docs/specs/semconv/gen-ai/_index.md
315-
- source: tmp/semconv/docs/general/README.md
316-
target: content/docs/specs/semconv/general/_index.md
317-
- source: tmp/semconv/docs/graphql/README.md
318-
target: content/docs/specs/semconv/graphql/_index.md
319-
- source: tmp/semconv/docs/hardware/README.md
320-
target: content/docs/specs/semconv/hardware/_index.md
321-
- source: tmp/semconv/docs/how-to-write-conventions/README.md
322-
target: content/docs/specs/semconv/how-to-write-conventions/_index.md
323-
- source: tmp/semconv/docs/http/README.md
324-
target: content/docs/specs/semconv/http/_index.md
325-
- source: tmp/semconv/docs/messaging/README.md
326-
target: content/docs/specs/semconv/messaging/_index.md
327-
- source: tmp/semconv/docs/mobile/README.md
328-
target: content/docs/specs/semconv/mobile/_index.md
329-
- source: tmp/semconv/docs/non-normative/compatibility/README.md
330-
target: content/docs/specs/semconv/non-normative/compatibility/_index.md
331-
- source: tmp/semconv/docs/non-normative/README.md
332-
target: content/docs/specs/semconv/non-normative/_index.md
333-
- source: tmp/semconv/docs/object-stores/README.md
334-
target: content/docs/specs/semconv/object-stores/_index.md
335-
- source: tmp/semconv/docs/otel/README.md
336-
target: content/docs/specs/semconv/otel/_index.md
337-
- source: tmp/semconv/docs/README.md
338-
target: content/docs/specs/semconv/_index.md
339-
- source: tmp/semconv/docs/registry/attributes/README.md
340-
target: content/docs/specs/semconv/registry/attributes/_index.md
341-
- source: tmp/semconv/docs/registry/entities/README.md
342-
target: content/docs/specs/semconv/registry/entities/_index.md
343-
- source: tmp/semconv/docs/registry/README.md
344-
target: content/docs/specs/semconv/registry/_index.md
345-
- source: tmp/semconv/docs/resource/cloud-provider/aws/README.md
346-
target: content/docs/specs/semconv/resource/cloud-provider/aws/_index.md
347-
- source: tmp/semconv/docs/resource/cloud-provider/gcp/README.md
348-
target: content/docs/specs/semconv/resource/cloud-provider/gcp/_index.md
349-
- source: tmp/semconv/docs/resource/cloud-provider/README.md
350-
target: content/docs/specs/semconv/resource/cloud-provider/_index.md
351-
- source: tmp/semconv/docs/resource/k8s/README.md
352-
target: content/docs/specs/semconv/resource/k8s/_index.md
353-
- source: tmp/semconv/docs/resource/README.md
354-
target: content/docs/specs/semconv/resource/_index.md
355-
- source: tmp/semconv/docs/rpc/README.md
356-
target: content/docs/specs/semconv/rpc/_index.md
357-
- source: tmp/semconv/docs/runtime/README.md
358-
target: content/docs/specs/semconv/runtime/_index.md
359-
- source: tmp/semconv/docs/system/README.md
360-
target: content/docs/specs/semconv/system/_index.md
361-
- source: tmp/semconv/docs/url/README.md
362-
target: content/docs/specs/semconv/url/_index.md
363-
# DO NOT EDIT - semconv autogenerated mounts above - DO NOT EDIT
364-
365-
## bn
366-
- source: content/bn
367-
target: content
368-
lang: bn
369-
# fallback pages
370-
- source: content/en/_includes
371-
target: content/_includes
372-
lang: bn
373-
- source: content/en/announcements
374-
target: content/announcements
375-
lang: bn
376-
- excludeFiles: specs/*
377-
source: content/en/docs
378-
target: content/docs
379-
lang: bn
380-
381-
## es
382-
- source: content/es
383-
target: content
384-
lang: es
385-
# fallback pages
386-
- source: content/en/_includes
387-
target: content/_includes
388-
lang: es
389-
- source: content/en/announcements
390-
target: content/announcements
391-
lang: es
392-
- excludeFiles: specs/*
393-
source: content/en/docs
394-
target: content/docs
395-
lang: es
396-
397-
## fr
398-
- source: content/fr
399-
target: content
400-
lang: fr
401-
# fallback pages
402-
- source: content/en/_includes
403-
target: content/_includes
404-
lang: fr
405-
- source: content/en/announcements
406-
target: content/announcements
407-
lang: fr
408-
- excludeFiles: specs/*
409-
source: content/en/docs
410-
target: content/docs
411-
lang: fr
412-
# - source: content/en/ecosystem
413-
# target: content/ecosystem
414-
# lang: fr
415-
416-
## ja
417-
- source: content/ja
418-
target: content
419-
lang: ja
420-
# fallback pages
421-
- source: content/en/_includes
422-
target: content/_includes
423-
lang: ja
424-
- source: content/en/announcements
425-
target: content/announcements
426-
lang: ja
427-
- excludeFiles: specs/*
428-
source: content/en/docs
429-
target: content/docs
430-
lang: ja
431-
432-
## ro
433-
- source: content/ro
434-
target: content
435-
lang: ro
436-
# fallback pages
437-
- source: content/en/_includes
438-
target: content/_includes
439-
lang: ro
440-
- source: content/en/announcements
441-
target: content/announcements
442-
lang: ro
443-
- excludeFiles: specs/*
444-
source: content/en/docs
445-
target: content/docs
446-
lang: ro
447-
448-
## uk
449-
- source: content/uk
450-
target: content
451-
lang: uk
452-
# fallback pages
453-
- source: content/en/_includes
454-
target: content/_includes
455-
lang: uk
456-
- source: content/en/announcements
457-
target: content/announcements
458-
lang: uk
459-
- excludeFiles: specs/*
460-
source: content/en/docs
461-
target: content/docs
462-
lang: uk
463-
464-
## zh
465-
- source: content/zh
466-
target: content
467-
lang: zh
468-
# fallback pages
469-
- source: content/en/_includes
470-
target: content/_includes
471-
lang: zh
472-
- source: content/en/announcements
473-
target: content/announcements
474-
lang: zh
475-
- excludeFiles: specs/*
476-
source: content/en/docs
477-
target: content/docs
478-
lang: zh
479-
480-
## pt
481-
- source: content/pt
482-
target: content
483-
lang: pt
484-
# fallback pages
485-
- source: content/en/_includes
486-
target: content/_includes
487-
lang: pt
488-
- source: content/en/announcements
489-
target: content/announcements
490-
lang: pt
491-
- excludeFiles: specs/*
492-
source: content/en/docs
493-
target: content/docs
494-
lang: pt
495-
- source: content/en/ecosystem
496-
target: content/ecosystem
497-
lang: pt
498-
499-
## static
500-
- source: static
501-
target: static
502-
- source: content-modules/semantic-conventions/schemas
503-
target: static/schemas
504-
- source: static/img
505-
target: static/img
506-
- source: content-modules/opentelemetry-specification/internal/img
507-
target: static/img
508-
- source: iconography/32x32
509-
target: static/img/logos/32x32
262+
#
263+
# mounts: are defined in module-template.yaml. See that file for processing
264+
# details. For information about Hugo config directories and files, see:
265+
# https://gohugo.io/configuration/introduction/#configuration-directory.

config/_default/module-template.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This Hugo config `mounts` template is rendered as `module.yaml` and
2+
# automatically used by Hugo. Also see `hugo.yaml` for other Hugo configuration.
3+
14
mounts:
25
## en
36
- source: content/en
@@ -167,3 +170,6 @@ mounts:
167170
target: static/img
168171
- source: iconography/32x32
169172
target: static/img/logos/32x32
173+
## site
174+
- source: config/_default/module.yaml
175+
target: static/site/config/module.yaml

content/en/docs/contributing/development.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,12 @@ might need to increase the file descriptor limit. See
122122
The website is built from the following content:
123123

124124
- Files under `content/`, `static/`, etc. per [Hugo] defaults.
125-
- Mount points, defined in [hugo.yaml] under `mounts`. Mounts are either
126-
directly from git submodules under [content-modules], or preprocessed content
127-
from `content-modules` (placed under `tmp/`), and no where else.
125+
- Mount points, defined by Hugo [config] in
126+
`config/_default/module-template.yaml`. Mounts are either directly from git
127+
submodules under [content-modules], or preprocessed content from
128+
`content-modules` (placed under `tmp/`), and no where else.
128129

129-
[hugo.yaml]:
130-
https://github.com/open-telemetry/opentelemetry.io/blob/main/hugo.yaml
130+
[config]: https://github.com/open-telemetry/opentelemetry.io/tree/main/config
131131
[content-modules]:
132132
https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules
133133

content/en/docs/contributing/localization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ with the task list given below:
363363
For details, see
364364
[Localize the homepage](https://opentelemetry.io/docs/contributing/localization/#homepage).
365365
- [ ] OTel maintainers:
366-
- [ ] Update `hugo.yaml`
366+
- [ ] Update Hugo config for `LANG_ID`
367367
- [ ] Configure cSpell and other tooling support
368368
- [ ] Create an issue label for `lang:LANG_ID`
369369
- [ ] Create org-level group for `LANG_ID` approvers
@@ -419,12 +419,12 @@ are easier to review and so typically get merged more quickly.
419419

420420
#### Hugo
421421

422-
Update `hugo.yaml`. Add appropriate entries for `LANG_ID` under:
422+
Update Hugo config for `LANG_ID`. Add appropriate entries for `LANG_ID` under:
423423

424-
- `languages`
425-
- `module.mounts`. At a minimum, add a single `source`-`target` entry for
426-
`content`. Consider adding entries for `en` fallback pages only once the
427-
locale has enough content.
424+
- `languages` in `config/_default/hugo.yaml`
425+
- `module.mounts` via `config/_default/module-template.yaml`. At a minimum, add
426+
a single `source`-`target` entry for `content`. Consider adding entries for
427+
`en` fallback pages only once the locale has enough content.
428428

429429
#### Spelling
430430

static/refcache.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12351,6 +12351,10 @@
1235112351
"StatusCode": 206,
1235212352
"LastSeen": "2025-10-25T15:30:05.09591169Z"
1235312353
},
12354+
"https://github.com/open-telemetry/opentelemetry.io/tree/main/config": {
12355+
"StatusCode": 206,
12356+
"LastSeen": "2025-10-31T05:56:47.948983-04:00"
12357+
},
1235412358
"https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules": {
1235512359
"StatusCode": 206,
1235612360
"LastSeen": "2025-10-25T15:30:39.395266003Z"

0 commit comments

Comments
 (0)