Merge pull request #98 from estruyf/dev

Merge for 1.11.0

.github/workflows/release.yml

@@ -79,11 +79,12 @@ jobs:
         doctor publish -a password --username "${{ secrets.USERNAME }}" --password "${{ secrets.PASSWORD }}" -u "${{ secrets[matrix.siteUrl] }}" --retryWhenFailed --cleanQuickLaunch --cleanEnd --confirm $startClean $skipPages
       env:
         DEBUG: ${{ secrets.DEBUG }}
+        TRANSLATOR_KEY: ${{ secrets.TRANSLATOR_KEY }}
 
 
   #############################################
   ### Publishing on Windows with PowerShell ###
-  ############################################
+  #############################################
   build_pwsh:
     name: Build windows-latest - powershell
     runs-on: windows-latest
@@ -143,6 +144,7 @@ jobs:
       shell: powershell
       env:
         DEBUG: ${{ secrets.DEBUG }}
+        TRANSLATOR_KEY: ${{ secrets.TRANSLATOR_KEY }}
 
 
   ######################################
@@ -198,6 +200,7 @@ jobs:
       shell: cmd
       env:
         DEBUG: ${{ secrets.DEBUG }}
+        TRANSLATOR_KEY: ${{ secrets.TRANSLATOR_KEY }}
 
 
   ##################################

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.11.0]
+
+
+- [#89](https://github.com/estruyf/doctor/issues/89): [Enhancement]: Use Cognitive Service Translation API connection for machine translations
+- [#90](https://github.com/estruyf/doctor/issues/90): [Enhancement]: Custom colors for callouts
+
 ## [1.10.0]
 
 

changelog.json

@@ -5,6 +5,13 @@
       { "id": null, "title": "" }
     ]
   },
+  {
+    "title": "1.11.0",
+    "updates": [
+      { "id": 89, "title": "[Enhancement]: Use Cognitive Service Translation API connection for machine translations" },
+      { "id": 90, "title": "[Enhancement]: Custom colors for callouts" }
+    ]
+  },
   {
     "title": "1.10.0",
     "updates": [

cypress/integration/shortcodes.ts

@@ -34,12 +34,12 @@ describe('Doctor shortcodes', function() {
   it('4. Check if callout tip exists', () => {
     cy.get(`.callout-tip`)
       .should('exist')
-      .should("have.length", 2)
+      .should("have.length", 3)
       .first()
       .should('have.css', 'background-color', 'rgb(186, 216, 10)');
 
     cy.get(`.callout-tip h5`)
-      .last()
+      .eq(1)
       .should('contain.text', 'OVERRIDE THE TITLE');
   });
 
@@ -72,4 +72,12 @@ describe('Doctor shortcodes', function() {
       .should('contain.text', 'HTML: Content of the external shortcode');
   });
 
+  it('9. check callout with custom background and foreground', () => {
+    cy.get(`.callout-tip`)
+      .should('exist')
+      .last()
+      .should('have.css', 'background-color', 'rgb(70, 39, 73)')
+      .should('have.css', 'color', 'rgb(253, 236, 239)');
+  });
+
 });

cypress/integration/translator.ts

@@ -0,0 +1,25 @@
+/// <reference types="cypress" />
+/// <reference types="../support" />
+
+describe('Multilingual validation', function() {
+  const PAGE_URL = "sitepages/doctor/nl/page-creation.aspx";
+
+  /**
+   * Before visiting SharePoint, we first need to authenticate
+   */
+  before(() =>  {
+    cy.visitSP(PAGE_URL);
+  });
+
+  after(() => {
+    cy.screenshot();
+  });
+
+  it('1. Check if language selector is available on the page', () => {
+    cy.get(`[data-automation-id="LanguageSelector"]`).should('exist').should("contain.text", "Dutch");
+  });
+
+  it('2. Check if the page contains the right language contents', () => {
+    cy.get(`h2#page-creation`).should('exist');
+  });
+});

docs/content/changelog/_index.md

@@ -6,6 +6,12 @@ description: The changelog of Doctor
 type: docs-main
 ---
 
+## [1.11.0]
+
+
+- [#89](https://github.com/estruyf/doctor/issues/89): [Enhancement]: Use Cognitive Service Translation API connection for machine translations
+- [#90](https://github.com/estruyf/doctor/issues/90): [Enhancement]: Custom colors for callouts
+
 ## [1.10.0]
 
 

docs/content/docs/multilingual/index.md

@@ -30,7 +30,8 @@ Example setup:
     "languages": [
       1043
     ],
-    "overwriteTranslationsOnChange": true
+    "overwriteTranslationsOnChange": true,
+    "translator:" null
   } 
 }
 ```
@@ -64,4 +65,36 @@ For the translation page, `home.nl.lang.md` in the above example, you should set
 
 By default, SharePoint will copy the header settings from the source page. If you want to override these settings, you can add the same options as all other pages as long as you make sure `type: translation` is set for these pages.
 
-> **Info**: Sample of how you can use multilingual with `doctor` has been provided in [https://github.com/estruyf/doctor-sample](https://github.com/estruyf/doctor-sample).
+> **Info**: Sample of how you can use multilingual with `doctor` has been provided in [https://github.com/estruyf/doctor-sample](https://github.com/estruyf/doctor-sample).
+
+## Using Azure Translator service
+
+If you want to make use of the Azure Translator service which is part of the [Azure Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/) family. You will first need to create the translator service in your Azure tenant and provide the following config:
+
+```json
+{
+  "multilingual": {
+    "enableTranslations": true,
+    "languages": [
+      1043
+    ],
+    "overwriteTranslationsOnChange": true,
+    "translator:" {
+      "key": "<subscription key>",
+      "endpoint": "https://api.cognitive.microsofttranslator.com/",
+      "region": "<region name, example: westeurope>"
+    }
+  } 
+}
+```
+
+### Automatically translate pages
+
+When you want to make use of this APIs for page translations. All you need to do is specifying the `localization` property to its front matter of the page. In this case, you do not need to specify the path to the page. As the page will be translated on the fly.
+
+```yaml
+localization: 
+  "nl-nl":
+```
+
+> **Info**: When you are going to run `doctor`. There will be `*.machinetranslated.md` pages created next to the parent page. This is done to not create any conflicts with the referenced pages and images. At the end of the process, `doctor` will remove these generated pages. During a `debug` run, they will not be removed. 

docs/content/docs/options/_index.md

@@ -131,8 +131,24 @@ You can provide the same flags and values like in the parameters. Parameters can
   - **enableTranslations**: `boolean` - Specifies if you want to enable or disable multilingual features on the site. Default: `false`.
   - **languages**: `number[]` - Locale IDs (or LCIDs) to enable on the site. An overview of the supported LCIDs for SharePoint can be found on [Supported LCIDs by SharePoint](https://github.com/pnp/PnP-PowerShell/wiki/Supported-LCIDs-by-SharePoint).
   - **overwriteTranslationsOnChange**: `boolean` - Specify whether the changes made to user-specified text in the default language should automatically overwrite the existing translations made in all alternate languages.
+  - **translator**: `Translator` - This property allows you to specify the Azure Translator Cognitive Service. When Specified, you allow `doctor` to use the translator APIs to machine translate your pages.
 
-Example:
+Manual translation example:
+
+```json
+{
+  "multilingual": {
+    "enableTranslations": true,
+    "languages": [
+      1043
+    ],
+    "overwriteTranslationsOnChange": true,
+    "translator:" null
+  } 
+}
+```
+
+Machine translation example:
 
 ```json
 {
@@ -141,7 +157,12 @@ Example:
     "languages": [
       1043
     ],
-    "overwriteTranslationsOnChange": true
+    "overwriteTranslationsOnChange": true,
+    "translator:" {
+      "key": "<subscription key>",
+      "endpoint": "https://api.cognitive.microsofttranslator.com/",
+      "region": "<region name, example: westeurope>"
+    }
   } 
 }
 ```

docs/content/docs/shortcodes/callout/_index.md

@@ -26,6 +26,8 @@ Example:
 <callout type="danger">The danger content</callout>
 
 <callout type="tip" title="Override the title">Tip content with a custom title</callout>
+
+<callout type="tip" title="Custom background and foreground color" bgColor=#462749" fgColor="#FDECEF">A callout to test the background and foreground colors.</callout>
 ```
 
 The following HTML attributes are supported for the `callout`:
@@ -36,4 +38,6 @@ The following HTML attributes are supported for the `callout`:
   - info
   - caution
   - danger
-- **title**: Allows you to specify a custom callout title
+- **title**: Allows you to specify a custom callout title
+- **bgColor**: Allows you to specify a custom background color
+- **fgColor**: Allows you to specify a custom foreground color

docs/data/upcomingVersion.json

@@ -1 +1 @@
-{"title":"1.10.0","updates":[{"id":82,"title":"[Enhancement]: Allow comments to be disabled at global level"},{"id":83,"title":"[Enhancement]: New implementation of the retry logic"},{"id":84,"title":"[BUG]: Issue with skipping pages and multilingual"},{"id":85,"title":"[BUG]: Fix recording video bug in Cypress during tests"},{"id":95,"title":"[Enhancement]: Add test results to the documentation to gain a better view on how they perform"}]}
+{"title":"1.11.0","updates":[{"id":89,"title":"[Enhancement]: Use Cognitive Service Translation API connection for machine translations"},{"id":90,"title":"[Enhancement]: Custom colors for callouts"}]}

docs/layouts/partials/footer.html

@@ -7,7 +7,7 @@
       </div>
       <div class="col-md-4 text-md-right text-center">
         <ul class="list-inline">
-          <li class="list-inline-item align-middle"><img src="http://estruyf-github.azurewebsites.net/api/VisitorHit?user=estruyf&repo=doctor&countColor=%2324BAA4" /></li>
+          <li class="list-inline-item align-middle"><img src="https://estruyf-github.azurewebsites.net/api/VisitorHit?user=estruyf&repo=doctor&countColor=%2324BAA4" /></li>
           {{ range .Site.Params.social }}
           <li class="list-inline-item"><a class="text-color d-inline-block p-2" href="{{ .link | safeURL }}"><i class="{{ .icon }}"></i></a></li>
           {{ end }}