influxdata / influxdata/docs-v2

docs(shared): split Core/Enterprise headings in config-options.md instead of interleaved show-in rows

Open
#7,468 0 comments 0 reactions 0 assignees View on GitHub
product:shared product:v3-monolith
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

## Summary

Follow-up to #7464. That issue fixed four instances where `{{% show-in %}}` spliced a bare table row (or shortcode closing tag) into a shared table, breaking rendering because `{{% show-in %}}`'s `.Inner` content is rendered as an independent Markdown document before being spliced back into the page.

The fix used a "self-contained table" workaround (own header + separator + row) at each broken location. That eliminates the specific bug but not the underlying pattern: `content/shared/influxdb3-cli/config-options.md` interleaves Enterprise-only content into shared tables/lists at ~37 separate `show-in "enterprise"` sites, any of which can reintroduce the same class of bug if edited without care.

## Proposal

Restructure `config-options.md` (and any other shared CLI reference files with the same pattern) to use separate "Core" and "Enterprise" headings/sections for option groups that differ between editions, instead of interleaving `show-in` blocks mid-table or mid-list. For example, a "Resource Limits" section would become:

```markdown
### Resource Limits

#### Core options
...core-only options and table...

{{% show-in "enterprise" %}}
#### Enterprise options
...enterprise-only options and table, as a complete standalone section...
{{% /show-in %}}
```

This keeps each `show-in` block wrapping a complete, self-contained section (heading + prose + table), never a fragment of shared markup, which removes this bug class structurally rather than patching each occurrence.

It's also likely more useful to an operator running both editions: on the Enterprise pages, they'd see clearly labeled "Core options" and "Enterprise options" headings and understand what's shared vs. Enterprise-specific, rather than needing to infer it from inline annotations.

## Constraints

- Must keep the existing "transclude, don't cross-link" pattern: Core pages should still read as fully self-contained (omit the Enterprise section entirely via `show-in`), not link out to Enterprise docs for the rest.
- Scope this to config-options.md first; audit other `content/shared/influxdb3-cli/**` files for the same interleaved-show-in pattern as a follow-up if it's found elsewhere.
- This is a content restructuring, not just a bug fix — needs a full pass through the file's ~37 `show-in "enterprise"` occurrences to decide which are simple inline annotations (fine as-is) vs. which interleave into shared tables/lists (candidates for the heading split).

## Related

- #7464 — original splicing bug and the self-contained-table workaround

Contributor guide

No contributing guide indexed for this repository

Research direction

Read content/shared/influxdb3-cli/config-options.md and review its roughly 37 `show-in "enterprise"` occurrences, using #7464 for the rendering context. Separate only the table/list interleavings into complete Core and Enterprise sections while preserving the existing transclusion behavior. Done means Core pages omit Enterprise sections and Enterprise pages show clearly labeled, self-contained sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.