Contrib.social

Improve documentation

Open on Drupal.org →
Created on 27 January 2023, over 1 year ago
Updated 19 May 2023, about 1 year ago

Documentation of this module can be improved in various aspects:

1. The documentation can be found here: https://www.drupal.org/docs/contributed-modules/office-365-connector → , but also here https://git.drupalcode.org/project/o365/-/blob/4.0.x/README.md.
Better use one source only to act as a single point of truth (and let the second source refer to the first), or keep both sources equal.

2. Include an overview of all submodules + one line description instead of an example of some submodules, https://git.drupalcode.org/project/o365/-/blob/4.0.x/README.md (The one line description would also come in handy here https://www.drupal.org/docs/contributed-modules/office-365-connector → . It may help in deciding which submodules to install or not.)

3. The Office 365 - Profiles and Personas REST submodule is missing from the submodules overview https://www.drupal.org/docs/contributed-modules/office-365-connector →

4. https://git.drupalcode.org/project/o365/-/blob/4.0.x/README.md (INSTALLATION) and https://www.drupal.org/docs/contributed-modules/office-365-connector → (Installing the module) are both referring to a url how to install a generic contrib Dupral module.
Better provide the specific example how to install the O365 module.

5. https://git.drupalcode.org/project/o365/-/blob/4.0.x/README.md (CONFIGURATION) show three app data settings (client_id, client_secret, and tenant_id) while https://www.drupal.org/docs/contributed-modules/office-365-connector/set... → shows four (+ website url) and the grey block show five (+ redirect_callback).

6. https://www.drupal.org/docs/contributed-modules/office-365-connector/set... → , being unfamiliar with Azure, the meaning of the options for point 3 (single tenant, multi tenant, etc.) are unclear (to me).

7. What should we do after we have completed all the steps here https://www.drupal.org/docs/contributed-modules/office-365-connector/set... → ? Go to the next page, or..?

8. https://www.drupal.org/docs/contributed-modules/office-365-connector/gen... → talks about #blocks. Is this general information?

9. See bottom of https://www.drupal.org/docs/contributed-modules/office-365-connector → Related Content may be removed? Introduction is not clickable, Office 365 Connector links back to the project.

10. The submodules lack some more explanation or description. (e.g. https://www.drupal.org/docs/contributed-modules/office-365-connector/3-s... → ) Or maybe update the product roadmap so users know better what they can expect in future.

📌 Task
Status

Needs review

Version

4.0

Component

Documentation

Created by

🇳🇱Netherlands batigolix Utrecht

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024