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.

Sign up for GitHub

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

Jump to bottom

chore(config, docs): handle initial integration of newly auto-generated sink documentation into existing Cue #14999

Open
50 tasks done
Tracked by #14812
tobz opened this issue Oct 28, 2022 · 1 comment
Open
50 tasks done
Tracked by #14812

chore(config, docs): handle initial integration of newly auto-generated sink documentation into existing Cue #14999

tobz opened this issue Oct 28, 2022 · 1 comment

Comments

@tobz
Copy link
Contributor

tobz commented Oct 28, 2022 •
edited by spencergilbert

Once #14814 is completed and we have a way to generate (near-)equivalent Cue documentation from the configuration schema itself, we need to tweak the existing Cue documentation to utilize it.

Main Outcomes

  • We should have a repeatable way to build the auto-generated documentation and then merge it into the "existing" Cue documentation, specifically for sinks.
  • We should maintain all of the other "custom" attributes and data currently present: we only want to use the auto-generated data for field-related documentation, not things like status badges, or "How It Works", etc.

(This is naturally a follow-on of #14998)

List of sinks to convert
@tobz tobz mentioned this issue Oct 28, 2022
Open
6 tasks
@neuronull
Copy link
Contributor

conversion guide:
#14998 (comment)

This was referenced Jan 24, 2023
Merged
Merged
Merged
Merged
Merged
@StephenWakely StephenWakely mentioned this issue Jan 27, 2023
Merged
This was referenced Jan 27, 2023
Merged
Merged
@StephenWakely StephenWakely mentioned this issue Jan 30, 2023
Merged
This was referenced Jan 30, 2023
Merged
Merged
@StephenWakely StephenWakely mentioned this issue Jan 31, 2023
Merged
@neuronull neuronull mentioned this issue Jan 31, 2023
Merged
This was referenced Feb 1, 2023
Merged
Merged
This was referenced Feb 1, 2023
Merged
Merged
Merged
Merged
This was referenced Feb 6, 2023
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tobz @neuronull