From 34207e05471f87564c6badeac9e13a00de4a716f Mon Sep 17 00:00:00 2001 From: zotlabs Date: Mon, 28 Oct 2019 16:47:55 -0700 Subject: [PATCH] start the doco rewrite --- Zotlabs/Module/Help.php | 12 ----- Zotlabs/Module/Well_known.php | 2 +- doc/TermsOfService.md | 11 ----- doc/{gdpr1.md => en/TermsOfService.md} | 42 +++++++++------- doc/{ => global}/dnt-policy.txt | 0 doc/site/README.md | 5 ++ include/help.php | 67 +++++++++----------------- view/tpl/help.tpl | 22 +-------- 8 files changed, 53 insertions(+), 108 deletions(-) delete mode 100644 doc/TermsOfService.md rename doc/{gdpr1.md => en/TermsOfService.md} (82%) rename doc/{ => global}/dnt-policy.txt (100%) create mode 100644 doc/site/README.md diff --git a/Zotlabs/Module/Help.php b/Zotlabs/Module/Help.php index 39a657979..73ffc14e4 100644 --- a/Zotlabs/Module/Help.php +++ b/Zotlabs/Module/Help.php @@ -79,20 +79,8 @@ class Help extends Controller { killme(); } - $headings = [ - 'about' => t('About'), - 'member' => t('Members'), - 'admin' => t('Administrators'), - 'developer' => t('Developers'), - 'tutorials' => t('Tutorials') - ]; - - if(array_key_exists(argv(1), $headings)) - $heading = $headings[argv(1)]; - $content = get_help_content(); - $language = determine_help_language()['language']; return replace_macros(get_markup_template('help.tpl'), array( '$title' => t('$Projectname Documentation'), diff --git a/Zotlabs/Module/Well_known.php b/Zotlabs/Module/Well_known.php index f954e231d..bd4cc3173 100644 --- a/Zotlabs/Module/Well_known.php +++ b/Zotlabs/Module/Well_known.php @@ -50,7 +50,7 @@ class Well_known extends Controller { break; case 'dnt-policy.txt': - echo file_get_contents('doc/dnt-policy.txt'); + echo file_get_contents('doc/global/dnt-policy.txt'); killme(); default: diff --git a/doc/TermsOfService.md b/doc/TermsOfService.md deleted file mode 100644 index 1e085559e..000000000 --- a/doc/TermsOfService.md +++ /dev/null @@ -1,11 +0,0 @@ -Privacy Policy -============== - -#include doc/gdpr1.md; - - -Terms of Service -================ - -#include doc/SiteTOS.md; - diff --git a/doc/gdpr1.md b/doc/en/TermsOfService.md similarity index 82% rename from doc/gdpr1.md rename to doc/en/TermsOfService.md index daa401a3d..4b4aa4340 100644 --- a/doc/gdpr1.md +++ b/doc/en/TermsOfService.md @@ -1,12 +1,18 @@ +Privacy Policy +============== Privacy Notice May 2018 +The following applies mainly to account registrants on this site. You may use this website +without registering for an account. + + How your information will be used ================================= Information you provide to this website may be stored and used to provide services to you. -We require an email address to idenitfy the account holder. This will not be shared with +We require an email address to identify the account holder. This will not be shared with any other website or service. It is used to send you notifications about your account and perform administrative tasks such as resetting your password. You have the option to opt-out of all email notifications through your settings. @@ -77,8 +83,7 @@ download for either archival puposes or to transfer to another compatible websit Your rights =========== -Under the General Data Protection Regulation -(GDPR) and The Data Protection Act 2018 +Under the General Data Protection Regulation (GDPR) and The Data Protection Act 2018 (DPA) you have a number of rights with regard to your personal data. You have the right to request from us access to and rectification or erasure of your personal data, the right to restrict processing, object to processing as well as in certain circumstances the right @@ -92,23 +97,24 @@ You have the right to lodge a complaint to the Information Commissioners’ Offi believe that we have not complied with the requirements of the GDPR or DPA 18 with regard to your personal data. +DMCA takedown notices (for illegal use of copyrighted information) MUST be initiated by the +owner of the copyright and should be addressed to the data protection officer, listed below. + + Identity and contact details of controller and data protection officer +====================================================================== [NAME OF COMPANY] -is the controller -[and processor] -of data for the purposes of the DPA 18 and GDPR. 3 +is the controller [and processor] of data for the purposes of the DPA section 18 and GDPR section 3. -If you have any concerns as to how your data is processed you can contact: +If you have any concerns as to how your data is processed you may contact: + +[Website operator should include their contact details here]. + + +Terms of Service +================ + + +This website is physically located in [COUNTRY] and all usage is subject to the laws thereof. -[ -[NAME] -Data Protection Offer at -[EMAIL ADDRESS] -] -[NAME] [JOB TITLE] -at -[EMAIL ADDRESS] -or you can write to these -individuals using the address of -[] diff --git a/doc/dnt-policy.txt b/doc/global/dnt-policy.txt similarity index 100% rename from doc/dnt-policy.txt rename to doc/global/dnt-policy.txt diff --git a/doc/site/README.md b/doc/site/README.md new file mode 100644 index 000000000..5bf8d2098 --- /dev/null +++ b/doc/site/README.md @@ -0,0 +1,5 @@ +The site directory is for local modifications of documentation files. + +Please copy the file doc/en/TermsOfService.md to doc/site/en/TermsOfService.md and add +the contact details for the site owner per the GDPR. You may also translate documentation +into other languages as desired. \ No newline at end of file diff --git a/include/help.php b/include/help.php index 70ff396ea..23b56e6a0 100644 --- a/include/help.php +++ b/include/help.php @@ -1,7 +1,7 @@
-
-
- -
- de - en - es - fr -
-
-
-

{{$title}}: {{$heading}}

+

{{$title}} {{$heading}}

-

- - - {{$tocHeading}} - -

- {{$content}}