Problem/Motivation

Improve the documentation in the README and the project page

- Clarify dependency on the Matomo contrib module (it is optional according to the project page, but required according to the readme).
- Update the readme according to the https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
- Separate installation steps from configuration steps
- the Security section in the readme is elaborate and contains information that is not specific to the module. Therefore it is better to link to a drupal.org page that explains secure storage of api keys
- the readme says there is a dependency on pfrenssen/matomo-reporting-api . This can be removed as it is downloaded automatical ly using composer. I hope?
- Is it necessary to refer to Piwik?
- Update references to Matomo UI
- Double check if Matomo UI and module use the same terminology (Auth token vs user token, etc.)
- Add API token and other matomo settings as a requirement
- Explain in the project page and readme what the benefits are of optionally enabling the Matomo module
- Use the module name "Matomo reporting API" consistent (using the same casing) throughout all the documentation and UI labels
- Refer to optional module "Matomo Analytics" consistently (using the same casing) throughout all the documentation and UI labels

Steps to reproduce

Read the readme.

Proposed resolution

Improve documentation according to the points above.

Remaining tasks

Do it

User interface changes

See above.

API changes

None

Data model changes

Nope

Issue fork matomo_reporting_api-3497207

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

batigolix created an issue. See original summary.

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Title: Clarify dependency on Matomo module » Improve documentation
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Assigned: Unassigned » batigolix

batigolix opened merge request !12

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Active » Needs review
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Assigned: batigolix » Unassigned
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue tags: +Documentation
arjenk’s picture

arjenk commented
Status: Needs review » Needs work

Overall good improvements;

  • Follows the guidelines from README.md template
  • better readable, better consistency in naming stuff

Three minor things i noticed:

  • the README.md there are 2 references to /admin/configure/.. should be /admin/config/..
  • the core_version_requirement: ">=8" is soo 2024, since d8 is not supported anymore
  • there is no 'composer require ...' command on the project page or in the README.md
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Needs work » Needs review

@arjenk: thanks for the feedback

> the README.md there are 2 references to /admin/configure/.. should be /admin/config/..

I fixed this

> the core_version_requirement: ">=8" is soo 2024, since d8 is not supported anymore

I changed to >=9

> there is no 'composer require ...' command on the project page or in the README.md

I cannot find an option to enable this. Maybe it is because the pipeline fails? I would like to address in this ticket #3509595: Make code pass Gitlab CI pipeline , but I want to get the documentation fixed first

arjenk’s picture

arjenk commented
Status: Needs review » Reviewed & tested by the community

Great, looks good to me.

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

  • batigolix committed 0e239577 on 3.0.x 
    [#3497207] feat: Improve documentation

By: batigolix
By: arjenk

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.