Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Component Docs Generation is platform dependent #22198

Open
pront opened this issue Jan 14, 2025 · 0 comments
Open

Component Docs Generation is platform dependent #22198

pront opened this issue Jan 14, 2025 · 0 comments
Assignees
Labels
domain: dev Anything related to Vector's development environment domain: external docs Anything related to Vector's external, public documentation type: bug A code related bug.

Comments

@pront
Copy link
Member

pront commented Jan 14, 2025

Summary

Configuration options behind features flags are compiled away when the feature is off.
When make generate-component-docs is run, the config options are removed from the docs.

Example

https://github.com/vectordotdev/vector/pull/22033/files#r1914968929

Proposed Solutions

  1. Show all configuration options on all platforms but produce an error during runtime if they are used.
  2. Generate static docs per platform.
  3. Draw inspiration from rustdoc and #[cfg(doc)]. For example, see the Available on Unix only. label in https://doc.rust-lang.org/std/os/unix/fs/fn.symlink.html.
@pront pront added type: bug A code related bug. domain: external docs Anything related to Vector's external, public documentation domain: dev Anything related to Vector's development environment labels Jan 14, 2025
@pront pront self-assigned this Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: dev Anything related to Vector's development environment domain: external docs Anything related to Vector's external, public documentation type: bug A code related bug.
Projects
None yet
Development

No branches or pull requests

1 participant