Add package-info.java and javadocs to document Entitlements design and implementation #127023
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ldematte
added
>non-issue
auto-backport
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
prdoyle
reviewed
Apr 17, 2025
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Show resolved
Hide resolved
...nt/src/main/java/org/elasticsearch/entitlement/initialization/EntitlementInitialization.java
Outdated
Show resolved
Hide resolved
libs/entitlement/src/main/java/org/elasticsearch/entitlement/instrumentation/Instrumenter.java
Outdated
Show resolved
Hide resolved
...ment/src/main/java/org/elasticsearch/entitlement/instrumentation/InstrumentationService.java
Show resolved
Hide resolved
libs/entitlement/src/main/java/org/elasticsearch/entitlement/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/src/main/java/org/elasticsearch/entitlement/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/src/main/java/org/elasticsearch/entitlement/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Patrick Doyle <[email protected]>
…icsearch into entitlements/package-docs
rjernst
approved these changes
Apr 19, 2025
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Outdated
Show resolved
Hide resolved
libs/entitlement/bridge/src/main/java/org/elasticsearch/entitlement/bridge/package-info.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Ryan Ernst <[email protected]>
💔 Backport failed
You can use sqren/backport to manually backport by running |
ldematte
added a commit
to ldematte/elasticsearch
that referenced
this pull request
Apr 22, 2025
…d implementation (elastic#127023) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
ldematte
added a commit
to ldematte/elasticsearch
that referenced
this pull request
Apr 22, 2025
…d implementation (elastic#127023) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
ldematte
added a commit
to ldematte/elasticsearch
that referenced
this pull request
Apr 22, 2025
…d implementation (elastic#127023) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 22, 2025
…d implementation (#127023) (#127141) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 22, 2025
…d implementation (#127023) (#127142) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 22, 2025
…d implementation (#127023) (#127143) Design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes. The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs. Relates to ES-11284
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As we discussed, design and implementation of Entitlement with this level of detail needs to stay close to the code, and take advantage of javadoc features like linking and class-references to help us with refactorings and future code changes.
The bulk of the information went into the package-info file for the main library, but I split up some parts and referenced them from the main doc, where I thought it made sense (mainly: the bridge sub-project for some implementation details, PolicyManager, EntitlementInitialization and FileAccessTree); this way they still can be reached from the "overview" while being closer to where the information really belongs.
Relates to ES-11284