Skip to content

Generate config props docs#25

Merged
dsyer merged 1 commit intospring-projects:mainfrom
onobc:generate-config-props-docs
Oct 8, 2024
Merged

Generate config props docs#25
dsyer merged 1 commit intospring-projects:mainfrom
onobc:generate-config-props-docs

Conversation

@onobc
Copy link
Copy Markdown
Contributor

@onobc onobc commented Oct 7, 2024

Caution

Review after #24 as this PR is built on top of the 2 commits in #24

This adds automatic config props document generation.
Screenshot 2024-10-06 at 22 33 37

Screenshot 2024-10-06 at 22 33 45

@@ -0,0 +1,18 @@
|===
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This file is automatically generated. Should we even check it in? I notice other spring-cloud repos are checking it in. I believe having it checked in avoids annoying red warnings coming from the consuming adocs that are referencing it.

/**
* Generate Asciidoc for configuration properties.
* <p>
* Copied from 'spring-cloud-build' to avoid direct dependency on Spring Cloud.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I did not want to put a direct dependency on spring-cloud-build just for this. I therefore copy/pasta shift/lift etc..

I will take a pass through this code in a subsequent PR as it can be simplified greatly and get a little 2024 makeover.

@dsyer
Copy link
Copy Markdown
Member

dsyer commented Oct 7, 2024

Might need to be rebased and force pushed your end?

@onobc onobc force-pushed the generate-config-props-docs branch from a8010d6 to eae26b0 Compare October 7, 2024 18:28
@onobc
Copy link
Copy Markdown
Contributor Author

onobc commented Oct 7, 2024

Might need to be rebased and force pushed your end?

Should be good now @dsyer . Thanks.

@onobc onobc force-pushed the generate-config-props-docs branch from eae26b0 to b40fa3e Compare October 7, 2024 18:30
@dsyer dsyer merged commit beba50b into spring-projects:main Oct 8, 2024
@onobc onobc deleted the generate-config-props-docs branch November 7, 2024 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants