Related to #2945976: Improve TFA documentation everywhere. Let's make sure we include plenty of documentation for this module. We shouldn't have to include too much installation and setup documentation if we make sure to link to any TFA documentation.

Including but not limited to:

  • Improve the readme.
  • Implement hook_help().
  • Link to TFA documentation where applicable.
  • Add a "Documentation guide" on drupal.org (specifically for the 8.x branch) so that it appears in the sidebar for the module's project page.
  • An official screencast that covers installation, setup, and usage of this module.
  • Links to any relevant blog posts or un-official screencasts found in the wild.

All other ideas are welcome.

Comments

daggerhart created an issue. See original summary.

aarailfan’s picture

aarailfan CreditAttribution: aarailfan as a volunteer commented

Is there any documentation anywhere on this module yet? A list of prerequisites? I'm trying to get this working in D8, and am having some issues with the whole process to make it work.

Thanks!

David

daggerhart’s picture

daggerhart CreditAttribution: daggerhart commented

Hi David,

Yes, there is documentation in the README for this module, but it could be better - https://cgit.drupalcode.org/ga_login/tree/readme.md?h=8.x-1.x

What I recommend instead is using the README for the TFA module, it goes into more detail about the setup steps - https://cgit.drupalcode.org/tfa/tree/README.md?h=8.x-1.x Once you have that module setup, adding the ga_login module is fairly straight forward.

For some additional help, a lot of the steps for setting up TFA mirror that of setting up field_encrypt. I've written a blog post about that here that goes into the details for setting up the key, encrypt, and real_aes modules - https://www.daggerhart.com/how-to-encrypt-field-data-drupal-8/ There is a video at the bottom of this post if you prefer videos.

If you run into any questions or problems, please reach out here or in the drupal slack channel #contrib-tfa. Anything we can do to improve this documentation would be very welcome.

aarailfan’s picture

aarailfan CreditAttribution: aarailfan as a volunteer commented

I was able to get this working by using composer to download it and all of the prerequisite modules. I hadn't been using composer previously due to problems with it working on my virtual hosting account, but hopefully I have resolved most of those issues.

jcnventura’s picture

jcnventura CreditAttribution: jcnventura at 1xINTERNET commented
Status: Active » Closed (won't fix)

I've decided to merge ga_login into the tfa module, as such theere will never be a stable release of ga_login. There will most likely be a forthcoming release that removes all code from this module to prevent site builders from re-enabling the duplicated code in this module.