Skip to content

docs: improve details #2925

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

Merged
merged 2 commits into from
Sep 1, 2025
Merged

docs: improve details #2925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e45a95
docs: improve details
csviri Sep 1, 2025
7d94764
wip
csviri Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/en/docs/contributing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Contributing To Java Operator SDK
title: Contributing
weight: 110
---

Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/documentation/error-handling-retries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ public class MyReconciler implements Reconciler<MyResource> {

Your custom retry class must:
- Provide a no-argument constructor for automatic instantiation
- Optionally implement `AnnotationConfigurable` for configuration from annotations
- Optionally implement `AnnotationConfigurable` for configuration from annotations. See [`GenericRetry`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetry.java#)
implementation for more details.

### Accessing Retry Information

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/faq/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Frequently Asked Questions
title: FAQ
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why not keep the acronym expansion?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's quite long on the menu bar takes 2 lines, this look better a bit imho

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

shortend also the contribution title, those are not that much of an issue, since we have others which multi lines, just a bit nicer

weight: 90
---

Expand Down