Add Javadoc for the categories
@@ -171,12 +171,36 @@ public abstract class ManagementLink implements ExtensionPoint, Action {
* @since TODO
*/
public enum Category {
+ /**
+ * Configuration pages that don't fit into a more specific section.
+ */
CONFIGURATION(Messages._ManagementLink_Category_CONFIGURATION()),
+ /**
+ * Security related options. Useful for plugins providing security related {@code ManagementLink}s (e.g. security realms).
+ * Use {@link Category#STATUS} instead if the feature is informational.
+ */
SECURITY(Messages._ManagementLink_Category_SECURITY()),
+ /**
+ * Status information about the Jenkins instance, such as log messages, load statistics, or general information.
+ */
STATUS(Messages._ManagementLink_Category_STATUS()),
+ /**
+ * Troubleshooting utilities. This overlaps some with status information, but the difference is that status
+ * always applies, while troubleshooting only matters when things go wrong.
+ */
TROUBLESHOOTING(Messages._ManagementLink_Category_TROUBLESHOOTING()),
+ /**
+ * Tools are specifically tools for administrators, such as the Jenkins CLI and Script Console, as well as specific stand-alone administrative features ({@link jenkins.management.ShutdownLink}, {@link jenkins.management.ReloadLink}).
+ * This has nothing to do with build tools or tool installers.
+ */
TOOLS(Messages._ManagementLink_Category_TOOLS()),
+ /**
+ * Anything that doesn't fit into any of the other categories. Expected to be necessary only very rarely.
+ */
MISC(Messages._ManagementLink_Category_MISC()),
+ /**
+ * The default category for uncategorized items. Do not explicitly specify this category for your {@code ManagementLink}.
+ */
UNCATEGORIZED(Messages._ManagementLink_Category_UNCATEGORIZED());
private Localizable label;
