diff options
author | Thomas Draebing <thomas.draebing@sap.com> | 2020-02-03 15:25:43 +0100 |
---|---|---|
committer | Thomas Draebing <thomas.draebing@sap.com> | 2020-02-03 15:40:27 +0100 |
commit | 5623d66a99bc34e7937ee0414e75aae689af2739 (patch) | |
tree | 7d729e198c30a756c8f4ab465691efcb4e1e0ebb | |
parent | 4fdfa625be4a956d551073fba300cd5b630a238e (diff) |
Revert "Document MessageOfTheDay extension"
This reverts commit cfff720610374fe538649f272a762569bb785998.
The message of the day functionality is still heavily depended on
components of Gerrit core. It is planned to move this functionality
completely to the plugin. Since it was not usable with the new UI for
a long while, the functionality will be removed completely until
then.
Change-Id: I6f8b13a92e8b20efce0748c27db631bacbda3123
-rw-r--r-- | Documentation/dev-plugins.txt | 34 | ||||
-rw-r--r-- | Documentation/rest-api-config.txt | 8 |
2 files changed, 3 insertions, 39 deletions
diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt index 3cde444707..e481d40666 100644 --- a/Documentation/dev-plugins.txt +++ b/Documentation/dev-plugins.txt @@ -2766,40 +2766,6 @@ class ApiQpsEnforcer implements QuotaEnforcer { } ---- -[[message-of-the-day]] -== Posting Messages (Of The Day) to the UI -Gerrit provides an extension point that enables plugins to implement a method to -collect messages that will then be shown below the main header in the Gerrit UI. - -[source, java] ----- -import com.google.gerrit.extensions.systemstatus.MessageOfTheDay; - -@Singleton -class MessageOfTheDayImpl extends MessageOfTheDay { - - private final String id; - private final String msg; - - public MessageOfTheDayImpl() { - id = "hello"; - msg = "I just wanted to say <b>hello</b>."; - } - - @Override - public String getHtmlMessage() { - return msg; - } - - @Override - public String getMessageId() { - return id; - } -} ----- - -Note, that the message will be added as HTML and parsed into the DOM. Thus, -plugins using this extension should ensure that the message content is safe. == SEE ALSO diff --git a/Documentation/rest-api-config.txt b/Documentation/rest-api-config.txt index 867016bad3..c83ed103d7 100644 --- a/Documentation/rest-api-config.txt +++ b/Documentation/rest-api-config.txt @@ -1899,8 +1899,7 @@ The number of open files. [[message-of-the-day-info]] === MessageOfTheDayInfo The `MessageOfTheDayInfo` entity contains information about a message -that was registered with the -link:dev-plugins.html#message-of-the-day[MessageOfTheDay]-extension by plugins. +that was registered with the `MessageOfTheDay`-extension by plugins. [options="header",cols="1,^1,5"] |=========================== @@ -1966,9 +1965,8 @@ Information about the configuration from the link:config-gerrit.html#gerrit[gerrit] section as link:#gerrit-info[ GerritInfo] entity. |`messages` || -List of messages registered with the -link:dev-plugins.html#message-of-the-day[MessageOfTheDay]-extension -containing link:#message-of-the-day-info[ +List of messages registered with the `MessageOfTheDay`- +extension containing link:#message-of-the-day-info[ MessageOfTheDayInfo] entities. |`note_db_enabled` |not set if `false`| Whether the NoteDb storage backend is fully enabled. |