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

docs: update go structs with updated format for docgen #8198

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

andrewrynhard
Copy link
Member

No description provided.

Copy link
Member

@smira smira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this would break machine config comments, JSON schema generation, etc.

it doesn't cover new machine config documents either

@andrewrynhard
Copy link
Member Author

andrewrynhard commented Jan 24, 2024

this would break machine config comments, JSON schema generation, etc.

it doesn't cover new machine config documents either

@smira
Copy link
Member

smira commented Jan 24, 2024

I think this need to be planned properly with exact ideas on what is going to be dropped, moved, removed, etc.

Can we do it with more transitional changes and less breaking changes?

How it's going to look in the end and so on. So far it won't pass the CI even.

@andrewrynhard
Copy link
Member Author

I think this need to be planned properly with exact ideas on what is going to be dropped, moved, removed, etc.

Can we do it with more transitional changes and less breaking changes?

How it's going to look in the end and so on. So far it won't pass the CI even.

This is a draft so I don't expect it to pass just yet. I posted in our private Slack I would like to discuss this week. This is just here in the form it is now to help illustrate the changes so we can have a more meaningful discussion.

@andrewrynhard
Copy link
Member Author

Picking this back up finally. Not ready for review yet but I want to use CI for testing. I plan on basing other PRs off of this one and going through a series of PRs that we can get aligned and push through.

@andrewrynhard
Copy link
Member Author

Not ready for review. Using CI to test.

Updates Go types for compatibility with an external implementation
of docgen.

Signed-off-by: Andrew Rynhard <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants