We have received feedback that our documentation is terrible! I think they are probably right. I thought I'd create an issue to try and improve things.

A couple of starting points:

  1. Improve the front page of the GDPR module, incl. updating the screenshots too
  2. Finalize the ReadMe file, see #2969647: README - incomplete
  3. Also update the current Help page of the module based on the t() function to be localizable.
  4. Copy over FreelyGive's https://freely-give.gitbook.io/gdpr/ onto the official D.org Docs section.
  5. Also include the current version of James' introductional video, which later on can be replaced with the updated version based on Peter's feedback.

Regarding to our reply to the inquiry from maniac0s on GitHub issue #18, Balu Ertl is the responsible at Brainsum company for producing documentation of this module set and his plan is to deliver the first good-enough revision before the Drupal Europe event. So anyone interested on the topic please subscribe on the mentioned Docs page on Drupal.org to follow any further updates on the progress.

Issue fork gdpr-2983948

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

yautja_cetanu created an issue. See original summary.

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Assigned: Unassigned » baluertl
Issue summary: View changes

Thanks, James for filing the issue. One other issue I remembered existing is #2969647: README - incomplete which still stands on me. Recognizing the relation of this two, plus your very valid action points, together brought me the idea to organize them into an epic. I did some backlog grooming on the issue queue's "Documentation" component, so now it holds 4 open issues. I went through them and set this issue as their parent to collect them under one roof.

Reworded the listing points in the issue description to look more like as doable tasks. Also, assigned to me as a reminder to start with point #4.

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Title: Overall improvement of the GDPR documentation » [epic] Overall improvement of the GDPR documentation
Issue summary: View changes
baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Issue summary: View changes
Status: Active » Needs work
alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented
Version: 8.x-2.x-dev » 3.0.x-dev

chandu7929 made their first commit to this issue’s fork.

chandu7929’s picture

chandu7929 commented

I am wondering if these two issue still need to work on:

  • Finalize the ReadMe file, see #2969647: README - incomplete
  • Also update the current Help page of the module based on the t() function to be localizable.

I checked 3.0.x today and its seems pretty much aligned to me.

rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented

I can see good documentation around GDPR here and here

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Assigned: baluertl » Unassigned
rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented
Assigned: Unassigned » rajeshreeputra

Started writing GDPR documentation on Drupal.Org.

Will update soon.

ankitv18’s picture

ankitv18 commented
Assigned: rajeshreeputra » ankitv18
rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented

Meanwhile the update is in progress, please review documentation completed so far.

rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented
Issue summary: View changes
Status: Needs work » Needs review
Issue tags: +ACMS2023
chandu7929’s picture

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

Updated GDPR document looks good to me.

rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented
Assigned: ankitv18 » Unassigned
Status: Reviewed & tested by the community » Fixed

Closing this issue as GDPR Documentation is now available on D.O, is required any updates to the doc same can be updated on the fly.

rajeshreeputra’s picture

rajeshreeputra
he/him
Location Pune
commented
Status: Fixed » Closed (fixed)