From 8ae03c37181822617418d1fc372982b245ac0a9a Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 3 Sep 2019 09:49:04 +0200
Subject: [PATCH] Add creation reason

---
 .../about-instance.component.html             | 12 +++--
 .../about-instance.component.ts               |  2 +
 .../edit-custom-config.component.html         | 26 ++++++---
 .../edit-custom-config.component.scss         |  4 +-
 .../edit-custom-config.component.ts           |  2 +
 config/default.yaml                           |  3 ++
 config/production.yaml.example                | 54 ++++++++++++++++++-
 server/controllers/api/config.ts              |  2 +
 server/initializers/config.ts                 |  2 +
 server/tests/api/check-params/config.ts       |  1 +
 server/tests/api/server/config.ts             |  3 ++
 shared/extra-utils/server/config.ts           |  1 +
 shared/models/server/about.model.ts           |  1 +
 shared/models/server/custom-config.model.ts   |  1 +
 14 files changed, 100 insertions(+), 14 deletions(-)

diff --git a/client/src/app/+about/about-instance/about-instance.component.html b/client/src/app/+about/about-instance/about-instance.component.html
index 80acfcce0..8b21137af 100644
--- a/client/src/app/+about/about-instance/about-instance.component.html
+++ b/client/src/app/+about/about-instance/about-instance.component.html
@@ -24,19 +24,25 @@
     </div>
 
     <div class="block administrator" *ngIf="html.administrator">
-      <div i18n class="section-title">Who are we?</div>
+      <div i18n class="section-title">Who we are</div>
 
       <div [innerHTML]="html.administrator"></div>
     </div>
 
+    <div class="block creation-reason" *ngIf="creationReason">
+      <div i18n class="section-title">Why we created this instance</div>
+
+      <p>{{ creationReason }}</p>
+    </div>
+
     <div class="block maintenance-lifetime" *ngIf="maintenanceLifetime">
-      <div i18n class="section-title">How long do we plan to maintain this instance?</div>
+      <div i18n class="section-title">How long we plan to maintain this instance</div>
 
       <p>{{ maintenanceLifetime }}</p>
     </div>
 
     <div class="block business-model" *ngIf="businessModel">
-      <div i18n class="section-title">How will we pay this instance?</div>
+      <div i18n class="section-title">How we will pay this instance</div>
 
       <p>{{ businessModel }}</p>
     </div>
diff --git a/client/src/app/+about/about-instance/about-instance.component.ts b/client/src/app/+about/about-instance/about-instance.component.ts
index e2c448501..b6cade4fe 100644
--- a/client/src/app/+about/about-instance/about-instance.component.ts
+++ b/client/src/app/+about/about-instance/about-instance.component.ts
@@ -25,6 +25,7 @@ export class AboutInstanceComponent implements OnInit {
     administrator: ''
   }
 
+  creationReason = ''
   maintenanceLifetime = ''
   businessModel = ''
 
@@ -61,6 +62,7 @@ export class AboutInstanceComponent implements OnInit {
       async ([ about, translations ]) => {
         this.shortDescription = about.instance.shortDescription
 
+        this.creationReason = about.instance.creationReason
         this.maintenanceLifetime = about.instance.maintenanceLifetime
         this.businessModel = about.instance.businessModel
 
diff --git a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html
index 5aa6fda3c..ef24e5b24 100644
--- a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html
+++ b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html
@@ -21,7 +21,7 @@
           <div class="form-group">
             <label i18n for="instanceShortDescription">Short description</label>
             <textarea
-              id="instanceShortDescription" formControlName="shortDescription"
+              id="instanceShortDescription" formControlName="shortDescription" class="small"
               [ngClass]="{ 'input-error': formErrors['instance.shortDescription'] }"
             ></textarea>
             <div *ngIf="formErrors.instance.shortDescription" class="form-error">{{ formErrors.instance.shortDescription }}</div>
@@ -130,14 +130,26 @@
           <div i18n class="inner-form-title">You and your instance</div>
 
           <div class="form-group">
-            <label i18n for="instanceAdministrator">Who is behind the instance? </label>
+            <label i18n for="instanceAdministrator">Who is behind the instance?</label>
             <div class="label-small-info">A single person? A non profit? A company?</div>
 
+            <my-markdown-textarea
+              id="instanceAdministrator" formControlName="administrator" textareaWidth="500px" textareaHeight="75px" [previewColumn]="true"
+              [classes]="{ 'input-error': formErrors['instance.administrator'] }"
+            ></my-markdown-textarea>
+
+            <div *ngIf="formErrors.instance.administrator" class="form-error">{{ formErrors.instance.administrator }}</div>
+          </div>
+
+          <div class="form-group">
+            <label i18n for="instanceCreationReason">Why did you create this instance?</label>
+            <div class="label-small-info">To share your personal videos? To open registrations and allow people to upload what they want?</div>
+
             <textarea
-              id="instanceAdministrator" formControlName="administrator"
-              [ngClass]="{ 'input-error': formErrors['instance.administrator'] }"
+              id="instanceCreationReason" formControlName="creationReason" class="small"
+              [ngClass]="{ 'input-error': formErrors['instance.creationReason'] }"
             ></textarea>
-            <div *ngIf="formErrors.instance.administrator" class="form-error">{{ formErrors.instance.administrator }}</div>
+            <div *ngIf="formErrors.instance.creationReason" class="form-error">{{ formErrors.instance.creationReason }}</div>
           </div>
 
           <div class="form-group">
@@ -145,7 +157,7 @@
             <div class="label-small-info">It's important to know for users who want to register on your instance</div>
 
             <textarea
-              id="instanceMaintenanceLifetime" formControlName="maintenanceLifetime"
+              id="instanceMaintenanceLifetime" formControlName="maintenanceLifetime" class="small"
               [ngClass]="{ 'input-error': formErrors['instance.maintenanceLifetime'] }"
             ></textarea>
             <div *ngIf="formErrors.instance.maintenanceLifetime" class="form-error">{{ formErrors.instance.maintenanceLifetime }}</div>
@@ -156,7 +168,7 @@
             <div class="label-small-info">With you own funds? With users donations? Advertising?</div>
 
             <textarea
-              id="instanceBusinessModel" formControlName="businessModel"
+              id="instanceBusinessModel" formControlName="businessModel" class="small"
               [ngClass]="{ 'input-error': formErrors['instance.businessModel'] }"
             ></textarea>
             <div *ngIf="formErrors.instance.businessModel" class="form-error">{{ formErrors.instance.businessModel }}</div>
diff --git a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.scss b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.scss
index 68f1b01b7..2b4d0da2c 100644
--- a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.scss
+++ b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.scss
@@ -44,8 +44,8 @@ textarea {
 
   display: block;
 
-  &#instanceShortDescription {
-    height: 100px;
+  &.small {
+    height: 75px;
   }
 }
 
diff --git a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts
index 3119ab040..e6f56bc97 100644
--- a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts
+++ b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts
@@ -100,6 +100,8 @@ export class EditCustomConfigComponent extends FormReactive implements OnInit {
 
         terms: null,
         codeOfConduct: null,
+
+        creationReason: null,
         moderationInformation: null,
         administrator: null,
         maintenanceLifetime: null,
diff --git a/config/default.yaml b/config/default.yaml
index f84ecfcf9..7ed096dcd 100644
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -243,6 +243,9 @@ instance:
   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
   moderation_information: '' # Supports markdown
 
+  # Why did you create this instance?
+  creation_reason: ''
+
   # Who is behind the instance? A single person? A non profit?
   administrator: ''
 
diff --git a/config/production.yaml.example b/config/production.yaml.example
index 397e52740..b86068bde 100644
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -251,9 +251,58 @@ auto_blacklist:
 instance:
   name: 'PeerTube'
   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
-  description: '' # Support markdown
-  terms: '' # Support markdown
+  description: 'Welcome to this PeerTube instance!' # Support markdown
+  terms: 'No terms for now.' # Support markdown
+  code_of_conduct: '' # Supports markdown
+
+  # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
+  moderation_information: '' # Supports markdown
+
+  # Why did you create this instance?
+  creation_reason: ''
+
+  # Who is behind the instance? A single person? A non profit?
+  administrator: ''
+
+  # How long do you plan to maintain this instance?
+  maintenance_lifetime: ''
+
+  # How will you pay the PeerTube instance server? With you own funds? With users donations? Advertising?
+  business_model: ''
+
+  # What are the main languages of your instance? To interact with your users for example
+  # Uncomment or add the languages you want
+  # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
+  languages:
+#    - en
+#    - es
+#    - fr
+
+  # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
+  # Uncomment or add the category ids you want
+  # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
+  categories:
+#    - 1  # Music
+#    - 2  # Films
+#    - 3  # Vehicles
+#    - 4  # Art
+#    - 5  # Sports
+#    - 6  # Travels
+#    - 7  # Gaming
+#    - 8  # People
+#    - 9  # Comedy
+#    - 10 # Entertainment
+#    - 11 # News & Politics
+#    - 12 # How To
+#    - 13 # Education
+#    - 14 # Activism
+#    - 15 # Science & Technology
+#    - 16 # Animals
+#    - 17 # Kids
+#    - 18 # Food
+
   default_client_route: '/videos/trending'
+
   # Whether or not the instance is dedicated to NSFW content
   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
@@ -261,6 +310,7 @@ instance:
   # By default, "do_not_list" or "blur" or "display" NSFW videos
   # Could be overridden per user with a setting
   default_nsfw_policy: 'do_not_list'
+
   customizations:
     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
diff --git a/server/controllers/api/config.ts b/server/controllers/api/config.ts
index b5244756d..909907ad6 100644
--- a/server/controllers/api/config.ts
+++ b/server/controllers/api/config.ts
@@ -161,6 +161,7 @@ function getAbout (req: express.Request, res: express.Response) {
       terms: CONFIG.INSTANCE.TERMS,
       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 
+      creationReason: CONFIG.INSTANCE.CREATION_REASON,
       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
@@ -232,6 +233,7 @@ function customConfig (): CustomConfig {
       terms: CONFIG.INSTANCE.TERMS,
       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
 
+      creationReason: CONFIG.INSTANCE.CREATION_REASON,
       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
       administrator: CONFIG.INSTANCE.ADMINISTRATOR,
       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
diff --git a/server/initializers/config.ts b/server/initializers/config.ts
index 4e2b07e64..8df411ca5 100644
--- a/server/initializers/config.ts
+++ b/server/initializers/config.ts
@@ -211,6 +211,8 @@ const CONFIG = {
     get TERMS () { return config.get<string>('instance.terms') },
     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 
+    get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
+
     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
diff --git a/server/tests/api/check-params/config.ts b/server/tests/api/check-params/config.ts
index f716dc673..9b902a1cd 100644
--- a/server/tests/api/check-params/config.ts
+++ b/server/tests/api/check-params/config.ts
@@ -29,6 +29,7 @@ describe('Test config API validators', function () {
       terms: 'my super terms',
       codeOfConduct: 'my super coc',
 
+      creationReason: 'my super reason',
       moderationInformation: 'my super moderation information',
       administrator: 'Kuja',
       maintenanceLifetime: 'forever',
diff --git a/server/tests/api/server/config.ts b/server/tests/api/server/config.ts
index da75495a5..85d0f9702 100644
--- a/server/tests/api/server/config.ts
+++ b/server/tests/api/server/config.ts
@@ -30,6 +30,7 @@ function checkInitialConfig (server: ServerInfo, data: CustomConfig) {
   expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
 
   expect(data.instance.terms).to.equal('No terms for now.')
+  expect(data.instance.creationReason).to.be.empty
   expect(data.instance.codeOfConduct).to.be.empty
   expect(data.instance.moderationInformation).to.be.empty
   expect(data.instance.administrator).to.be.empty
@@ -90,6 +91,7 @@ function checkUpdatedConfig (data: CustomConfig) {
   expect(data.instance.description).to.equal('my super description')
 
   expect(data.instance.terms).to.equal('my super terms')
+  expect(data.instance.creationReason).to.equal('my super creation reason')
   expect(data.instance.codeOfConduct).to.equal('my super coc')
   expect(data.instance.moderationInformation).to.equal('my super moderation information')
   expect(data.instance.administrator).to.equal('Kuja')
@@ -212,6 +214,7 @@ describe('Test config', function () {
         terms: 'my super terms',
         codeOfConduct: 'my super coc',
 
+        creationReason: 'my super creation reason',
         moderationInformation: 'my super moderation information',
         administrator: 'Kuja',
         maintenanceLifetime: 'forever',
diff --git a/shared/extra-utils/server/config.ts b/shared/extra-utils/server/config.ts
index 785421c98..66e0a008e 100644
--- a/shared/extra-utils/server/config.ts
+++ b/shared/extra-utils/server/config.ts
@@ -55,6 +55,7 @@ function updateCustomSubConfig (url: string, token: string, newConfig: DeepParti
       terms: 'my super terms',
       codeOfConduct: 'my super coc',
 
+      creationReason: 'my super creation reason',
       moderationInformation: 'my super moderation information',
       administrator: 'Kuja',
       maintenanceLifetime: 'forever',
diff --git a/shared/models/server/about.model.ts b/shared/models/server/about.model.ts
index e32ed26ee..bde4e0b50 100644
--- a/shared/models/server/about.model.ts
+++ b/shared/models/server/about.model.ts
@@ -7,6 +7,7 @@ export interface About {
 
     codeOfConduct: string
 
+    creationReason: string
     moderationInformation: string
     administrator: string
     maintenanceLifetime: string
diff --git a/shared/models/server/custom-config.model.ts b/shared/models/server/custom-config.model.ts
index 0c331a820..a7c2a3bab 100644
--- a/shared/models/server/custom-config.model.ts
+++ b/shared/models/server/custom-config.model.ts
@@ -8,6 +8,7 @@ export interface CustomConfig {
     terms: string
     codeOfConduct: string
 
+    creationReason: string
     moderationInformation: string
     administrator: string
     maintenanceLifetime: string
-- 
2.25.1