From e46688af604e36ec82874fa68938e0863b48382e Mon Sep 17 00:00:00 2001 From: Darran Lofthouse Date: Sun, 15 Sep 2024 11:50:39 +0100 Subject: [PATCH 1/3] Add requirements for our admin client to the process and template. --- FEATURE_PROCESS.adoc | 26 ++++++++++++++++++++++++++ design-doc-template.adoc | 10 ++++++++++ 2 files changed, 36 insertions(+) diff --git a/FEATURE_PROCESS.adoc b/FEATURE_PROCESS.adoc index 473b5a60..d1235736 100644 --- a/FEATURE_PROCESS.adoc +++ b/FEATURE_PROCESS.adoc @@ -70,6 +70,32 @@ All hard requirements in analysis covered | Encouraged |Encouraged |Encouraged |Required //------- +//------- + +| *Admin Clients* +(HAL / JBoss CLI) + +| Management model changes must be compatible with the lowe level model +manipulation capabilities of the admin clients. + +Breakage of high level client functionality is undesirable but accepted. + +| Experimental plus: + +Existing functionality in the admin clients must not be broken by the new +addition. Higher level client integration is not required. + +| Preview plus: + +Existing higher level views and commands in the admin clients must be +compatible with the new functionality. + +New higher level views and command in the admin clients are not mandatory +unless required for the feature to be considered "complete". + +| Same as Community + +//------- //------- | *Component Validation* diff --git a/design-doc-template.adoc b/design-doc-template.adoc index c9f07355..b643d3a3 100644 --- a/design-doc-template.adoc +++ b/design-doc-template.adoc @@ -103,6 +103,16 @@ into this category, please mention the Release Coordinators on the pull request so they are aware. //// +== Admin Clients + +//// +Identify the level of compatibility this feature will have with the existing +admin clients (JBoss CLI and the Admin Console / HAL). + +Identify any follow up work that will be required in the clients and link issues +created to track this work. +//// + == Security Considerations //// From f42446b3840f571c1ba3795df578890e1628f72e Mon Sep 17 00:00:00 2001 From: Darran Lofthouse Date: Sun, 15 Sep 2024 11:51:21 +0100 Subject: [PATCH 2/3] Also ignore .vscode files. --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 16372a4b..2787efc5 100644 --- a/.gitignore +++ b/.gitignore @@ -30,6 +30,8 @@ transaction.log *.swp /.gitk-tmp.* atlassian-ide-plugin.xml +# VSCode Files +.vscode # temp files *~ # maven versions plugin From c5a443f86c788ad345e3abf835cda91454947e8b Mon Sep 17 00:00:00 2001 From: Darran Lofthouse Date: Mon, 16 Sep 2024 14:28:17 +0100 Subject: [PATCH 3/3] Update how the guidance comment is included in the template as we are moving away from embedded comments. --- FEATURE_PROCESS.adoc | 2 +- design-doc-template.adoc | 8 +------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/FEATURE_PROCESS.adoc b/FEATURE_PROCESS.adoc index d1235736..cd8fa9bc 100644 --- a/FEATURE_PROCESS.adoc +++ b/FEATURE_PROCESS.adoc @@ -75,7 +75,7 @@ All hard requirements in analysis covered | *Admin Clients* (HAL / JBoss CLI) -| Management model changes must be compatible with the lowe level model +| Management model changes must be compatible with the lower level model manipulation capabilities of the admin clients. Breakage of high level client functionality is undesirable but accepted. diff --git a/design-doc-template.adoc b/design-doc-template.adoc index b643d3a3..a4a5021d 100644 --- a/design-doc-template.adoc +++ b/design-doc-template.adoc @@ -105,13 +105,7 @@ request so they are aware. == Admin Clients -//// -Identify the level of compatibility this feature will have with the existing -admin clients (JBoss CLI and the Admin Console / HAL). - -Identify any follow up work that will be required in the clients and link issues -created to track this work. -//// +____ == Security Considerations