Skip to content

Polish reference docs #61

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

Merged
merged 1 commit into from
Aug 11, 2022

Conversation

onobc
Copy link
Collaborator

@onobc onobc commented Aug 11, 2022

  • Remove hardcoded code where possible
  • Link to auto-generated config props rather than hardcoded tables
  • Simplify some wording

@sobychacko I still need to do the "Producer Factory Caching" and will do that tomorrow am. But I wanted to get this round of mods out there asap.

If you want to view the output locally then do these steps:

  • Run ./gradlew clean build -x test from the root dir
  • Navigate to ./spring-pulsar-docs/build/docs/asciidocMultipage/pulsar.html
  • Click Preview button in IDEA or open directly in browser

I think you will like what you see.

ℹ️ the next thing we need to do is pull the inline code in the doc out into the docs/src where possible and include source for the bigger examples. Otherwise it will get stale quickly.

- Remove hardcoded code where possible
- Link to auto-generated config props rather than hardcoded tables
- Simplify some wording
@onobc onobc requested a review from sobychacko August 11, 2022 06:35
@sobychacko sobychacko merged commit b145c3f into spring-projects:main Aug 11, 2022
@onobc onobc deleted the cbono-update-ref-guide branch September 11, 2022 17:30
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