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

[improve][doc] Java example explaining code without using lombok #19019

Merged
merged 4 commits into from
Dec 26, 2022

Conversation

AlvaroStream
Copy link
Contributor

Motivation

Following strictly the example can make people that doesn't use lombok get this error:

No serializer found for class com.mytest.Product and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)

Modifications

Increase the documentation on the code example.

Verifying this change

  • Make sure that the change passes the CI checks.

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

I tried executing the sh start.sh:


[SUCCESS] Docusaurus website is running at: http://localhost:3000/

✔ Client
  Compiled successfully in 27.76s

client (webpack 5.75.0) compiled with 1 warning
<w> [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[6].use[1]!/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[6].use[2]!/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/src/css/custom.css': No serializer registered for Warning
<w> while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> Array { 1 items } -> webpack/lib/ModuleWarning -> Warning

But I couldn't access the docs:

http://localhost:3000/docs/schema-understand/
http://localhost:3000/docs/2.10.x/schema-understand/

Was giving always Page Not found

Matching PR in forked repository

PR in forked repository: https://github.com/AlvaroStream/pulsar

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Dec 21, 2022
@codelipenghui
Copy link
Contributor

@AlvaroStream

I noticed you have removed

   @Builder
    @AllArgsConstructor
    @NoArgsConstructor

From the last comment #19019 (comment). We don't need to add the constructors if we have the annotation. The Lombok will generate them.

We should remove https://github.com/apache/pulsar/pull/19019/files#diff-fe3c06d8365d562427069af4376e699002169fdcf1047e836e771ce355756044R130-R134 if we have Lombok annotations.

@AlvaroStream
Copy link
Contributor Author

@codelipenghui sorry, I missunderstood. Now is better?

@codelipenghui codelipenghui merged commit b42aed1 into apache:master Dec 26, 2022
@AlvaroStream AlvaroStream deleted the alvaro/lombok branch December 26, 2022 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants