Merge pull request #2098 from matrix-org/travis/1.0/modules-update

Clarify what a "module" is and update feature profiles for clients

changelogs/client_server/newsfragments/2098.clarification

@@ -0,0 +1 @@
+Clarify what a "module" is and update feature profiles for clients.

specification/feature_profiles.rst

@@ -1,4 +1,5 @@
 .. Copyright 2016 OpenMarket Ltd
+.. Copyright 2019 The Matrix.org Foundation C.I.C.
 ..
 .. Licensed under the Apache License, Version 2.0 (the "License");
 .. you may not use this file except in compliance with the License.
@@ -32,33 +33,67 @@ Summary
   Module / Profile                       Web       Mobile    Desktop       CLI     Embedded
 ===================================== ========== ========== ========== ========== ==========
  `Instant Messaging`_                  Required   Required   Required   Required   Optional
+ `Direct Messaging`_                   Required   Required   Required   Required   Optional
+ `Mentions`_                           Required   Required   Required   Optional   Optional
  `Presence`_                           Required   Required   Required   Required   Optional
  `Push Notifications`_                 Optional   Required   Optional   Optional   Optional
  `Receipts`_                           Required   Required   Required   Required   Optional
+ `Fully read markers`_                 Optional   Optional   Optional   Optional   Optional
  `Typing Notifications`_               Required   Required   Required   Required   Optional
  `VoIP`_                               Required   Required   Required   Optional   Optional
+ `Ignoring Users`_                     Required   Required   Required   Optional   Optional
+ `Reporting Content`_                  Optional   Optional   Optional   Optional   Optional
  `Content Repository`_                 Required   Required   Required   Optional   Optional
  `Managing History Visibility`_        Required   Required   Required   Required   Optional
  `Server Side Search`_                 Optional   Optional   Optional   Optional   Optional
+ `Room Upgrades`_                      Required   Required   Required   Required   Optional
  `Server Administration`_              Optional   Optional   Optional   Optional   Optional
  `Event Context`_                      Optional   Optional   Optional   Optional   Optional
  `Third Party Networks`_               Optional   Optional   Optional   Optional   Optional
+ `Send-to-Device Messaging`_           Optional   Optional   Optional   Optional   Optional
+ `Device Management`_                  Optional   Optional   Optional   Optional   Optional
+ `End-to-End Encryption`_              Optional   Optional   Optional   Optional   Optional
+ `Guest Accounts`_                     Optional   Optional   Optional   Optional   Optional
+ `Room Previews`_                      Optional   Optional   Optional   Optional   Optional
+ `Client Config`_                      Optional   Optional   Optional   Optional   Optional
+ `SSO Login`_                          Optional   Optional   Optional   Optional   Optional
+ `OpenID`_                             Optional   Optional   Optional   Optional   Optional
+ `Stickers`_                           Optional   Optional   Optional   Optional   Optional
+ `Server ACLs`_                        Optional   Optional   Optional   Optional   Optional
+ `Server Notices`_                     Optional   Optional   Optional   Optional   Optional
 ===================================== ========== ========== ========== ========== ==========
 
 *Please see each module for more details on what clients need to implement.*
 
 .. _Instant Messaging: `module:im`_
+.. _Direct Messaging: `module:dm`_
+.. _Mentions: `module:mentions`_
 .. _Presence: `module:presence`_
 .. _Push Notifications: `module:push`_
 .. _Receipts: `module:receipts`_
+.. _Fully read markers: `module:read-markers`_
 .. _Typing Notifications: `module:typing`_
 .. _VoIP: `module:voip`_
+.. _Ignoring Users: `module:ignore_users`_
+.. _Reporting Content: `module:report_content`_
 .. _Content Repository: `module:content`_
 .. _Managing History Visibility: `module:history-visibility`_
 .. _Server Side Search: `module:search`_
+.. _Room Upgrades: `module:room-upgrades`_
 .. _Server Administration: `module:admin`_
 .. _Event Context: `module:event-context`_
 .. _Third Party Networks: `module:third-party-networks`_
+.. _Send-to-Device Messaging: `module:to_device`_
+.. _Device Management: `module:device-management`_
+.. _End-to-End Encryption: `module:e2e`_
+.. _Guest Accounts: `module:guest-access`_
+.. _Room Previews: `module:room-previews`_
+.. _Client Config: `module:account_data`_
+.. _SSO Login: `module:sso_login`_
+.. _OpenID: `module:openid`_
+.. _Stickers: `module:stickers`_
+.. _Server ACLs: `module:server-acls`_
+.. Server Notices already has a link elsewhere.
 
 Clients
 -------
@@ -110,4 +145,3 @@ This is a client which is typically running on an embedded device such as a
 kettle, fridge or car. These clients tend to perform a few operations and run
 in a resource constrained environment. Like embedded applications, they are
 not intended to be fully-fledged communication systems.
-

specification/modules.rst

@@ -1,4 +1,5 @@
 .. Copyright 2016 OpenMarket Ltd
+.. Copyright 2019 The Matrix.org Foundation C.I.C.
 ..
 .. Licensed under the Apache License, Version 2.0 (the "License");
 .. you may not use this file except in compliance with the License.
@@ -15,3 +16,12 @@
 Modules
 =======
 
+Modules are parts of the Client-Server API which are not universal to all
+endpoints. Modules are strictly defined within this specification and
+should not be mistaken for experimental extensions or optional features.
+A compliant server implementation MUST support all modules and supporting
+specification (unless the implementation only targets clients of certain
+profiles, in which case only the required modules for those feature profiles
+MUST be implemented). A compliant client implementation MUST support all
+the required modules and supporting specification for the `Feature Profile <#feature-profiles>`_
+it targets.

specification/modules/_template.rst

@@ -15,6 +15,7 @@
 Module Heading
 ==============
 
+.. NOTE: Prefer to identify-modules-with-dashes despite historical examples.
 .. _module:short-name:
 
 A short summary of the module. What features does this module provide? An anchor
@@ -67,4 +68,3 @@ This includes privacy leaks: for example leaking presence info. How do
 misbehaving clients or servers impact this module? This section should always be
 included, if only to say "we've thought about it but there isn't anything to do
 here".
-