docs: add labels for syncing documents to knowledge base

- remove obsolete ditamaps and properties - adjusted hierarchy of headlines for changelog.md
intershop · Mar 16, 2020 · b4280a2 · b4280a2
1 parent 324536c
commit b4280a2
Show file tree

Hide file tree

Showing 12 changed files with 97 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,13 @@
-# [0.18.0](https://github.com/intershop/intershop-pwa/releases/tag/0.18.0) (2020-03-09)
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_releasenote
+kb_everyone
+-->
+
+# Changelog
+
+## [0.18.0](https://github.com/intershop/intershop-pwa/releases/tag/0.18.0) (2020-03-09)
 
 **required Intershop Commerce Management version: 7.10.16.6**
 
@@ -47,7 +56,7 @@
 - **schematics:** prevent using same name for store and store-group ([09d66f4](https://github.com/intershop/intershop-pwa/commit/09d66f4))
 - **schematics:** make store location selection more robust ([c0ab56c](https://github.com/intershop/intershop-pwa/commit/c0ab56c))
 
-# [0.17.0](https://github.com/intershop/intershop-pwa/releases/tag/0.17.0) (2020-01-24)
+## [0.17.0](https://github.com/intershop/intershop-pwa/releases/tag/0.17.0) (2020-01-24)
 
 **required Intershop Commerce Management version: 7.10.15.2**
 
@@ -103,7 +112,7 @@
 - Using containers and components is no longer a recommended pattern. See [Migrations /
   0.16 to 0.17](https://github.com/intershop/intershop-pwa/blob/develop/docs/migrations.md#016-to-017) for more details.
 
-# [0.16.1](https://github.com/intershop/intershop-pwa/releases/tag/0.16.1) (2019-12-13)
+## [0.16.1](https://github.com/intershop/intershop-pwa/releases/tag/0.16.1) (2019-12-13)
 
 > NOTE: To address the issue with trademarked content or content of questionable origin it was neccessary to clean the complete GitHub repository resulting in a rewritten history. Because of that change it is advisable to work with a new clone of the repository.
 
@@ -121,7 +130,7 @@
 - switch from roboto font files contained in the sources to ones provided via npm packages
 - move all used images to a central img folder for a better overview
 
-# [0.16.0](https://github.com/intershop/intershop-pwa/releases/tag/0.16.0) (2019-11-29)
+## [0.16.0](https://github.com/intershop/intershop-pwa/releases/tag/0.16.0) (2019-11-29)
 
 **required Intershop Commerce Management version: 7.10.15.2**
 
@@ -176,7 +185,7 @@
 - The feature toggle 'captcha' was renamed to 'captchaV2' in contrast to the newly introduced 'captchaV3' option that could be used with the reCaptcha V3 service activated in ICM and the PWA.
 - To resolve naming conflicts for the upcoming removal of the container-component-pattern some containers and components were merged into simpler components.
 
-# [0.15.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.15.0/) (2019-10-11)
+## [0.15.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.15.0/) (2019-10-11)
 
 **required Intershop Commerce Management version: 7.10.14.0**
 
@@ -216,7 +225,7 @@
 - Using NgRx artifacts in Angular components is now deprecated, use facades instead.
 - Changed default import references for relative imports within the project and adapted tslint rules to enforce it (old import notation would still work but would lead to tslint errors).
 
-# [0.14.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.14.0/) (2019-09-10)
+## [0.14.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.14.0/) (2019-09-10)
 
 **required Intershop Commerce Management version: 7.10.13.4**
 
@@ -262,7 +271,7 @@
 - due to file system restrictions, mock-data file names no longer contain parameters
 - CMSModule is now integrated into SharedModule
 
-# 0.13.1 (2019-08-01)
+## 0.13.1 (2019-08-01)
 
 **required Intershop Commerce Management version: 7.10.13.1**
 
@@ -275,7 +284,7 @@
 - fix responsive design of edit modal for variation products in the cart (ISREST-792)
 - expression changed after it has been checked error for quoting with recently viewed products on product detail page (ISREST-765)
 
-# [0.13.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.13.0/) (2019-07-23)
+## [0.13.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.13.0/) (2019-07-23)
 
 **required Intershop Commerce Management version: 7.10.12.2**
 
@@ -300,7 +309,7 @@
 - set Bootstrap default body color to our themes color-primary
 - wait till app is stable before starting timers
 
-# [0.12.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.12.0/) (2019-06-13)
+## [0.12.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.12.0/) (2019-06-13)
 
 **required Intershop Commerce Management version: 7.10.9.0**
 
@@ -330,7 +339,7 @@
 - change out of stock text in line item description (ISREST-675)
 - improved english and german localization texts and added french localization for addresses (ISREST-727)
 
-# [0.11.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.11.0/) (2019-04-24)
+## [0.11.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.11.0/) (2019-04-24)
 
 **required Intershop Commerce Management version: 7.10.7.3**
 
@@ -358,7 +367,7 @@
 - compare explanation text styling (ISREST-638)
 - do not create select options if quantity selection is displayed as input
 
-# [0.10.5](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.10.5/) (2019-03-12)
+## [0.10.5](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.10.5/) (2019-03-12)
 
 **required Intershop Commerce Management version: 7.10.5.5**
 
@@ -383,7 +392,7 @@
 
 - renamed Angular CLI environment property 'needMock' to 'mockServerAPI' (now optional)
 
-# [0.9.1](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.9.1/) (2019-02-07)
+## [0.9.1](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.9.1/) (2019-02-07)
 
 ### Features
 
@@ -397,7 +406,7 @@
 - compare products columns don't have same sizes on mobile (ISREST-558)
 - various quoting issues (ISREST-588)
 
-# [0.9.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.9.0/) (2019-01-31)
+## [0.9.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.9.0/) (2019-01-31)
 
 **required Intershop Commerce Management version: 7.10.5.4**
 
@@ -435,7 +444,7 @@
 - Properties ICM_APPLICATION (system environment) and icmApplication (environment.ts) are correctly renamed to ICM_CHANNEL and icmChannel respectively.
 - Features now have to be supplied using a string array or as a string containing a comma separated list. Features are now opt-in instead of previously opt-out.
 
-# [0.8.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.8.0/) (2018-12-20)
+## [0.8.0](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.8.0/) (2018-12-20)
 
 **required Intershop Commerce Management version: 7.10.5.2**
 
@@ -472,20 +481,20 @@
 
 - Folder structure changed due to module refactoring.
 
-# [0.7.10](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.7.10/) (2018-09-10)
+## [0.7.10](https://repository.intershop.de/releases/com/intershop/public/source/intershop-pwa/0.7.10/) (2018-09-10)
 
 First public release of the Intershop Progressive Web App
 
 **required Intershop Commerce Management version: 7.10.2.4**
 
-# 0.6.0 (2018-09-08)
+## 0.6.0 (2018-09-08)
 
 ### Features
 
 - CMS integration - conditional rendering (ISREST-213) - EXPERIMENTAL
 - sticky header - header styling and behavior changes (ISREST-435) - EXPERIMENTAL
 
-# 0.5.0 (2018-09-07)
+## 0.5.0 (2018-09-07)
 
 ### Features
 
@@ -506,7 +515,7 @@ First public release of the Intershop Progressive Web App
 - add changelog generation with conventional-changelog
 - add license information and 3rd-party-licenses overview
 
-# 0.4.0 (2018-08-22)
+## 0.4.0 (2018-08-22)
 
 ### Features
 
@@ -520,7 +529,7 @@ First public release of the Intershop Progressive Web App
 - repair state transfer to work with ngrx state management
 - improve mobile menu handling
 
-# [0.3.0](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.3.0/) (2018-08-08)
+## [0.3.0](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.3.0/) (2018-08-08)
 
 ### Features
 
@@ -532,7 +541,7 @@ First public release of the Intershop Progressive Web App
 - update Angular to 6.1.0 (+ update of other dependencies)
 - introduce manually managed change log
 
-# [0.2.0](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.2.0/) (2018-07-11)
+## [0.2.0](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.2.0/) (2018-07-11)
 
 ### Features
 
@@ -542,10 +551,10 @@ First public release of the Intershop Progressive Web App
 
 - improve IE 11 compatibility
 
-# [0.1.1](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.1.1/) (2018-06-05)
+## [0.1.1](https://repository.intershop.de//releases/com/intershop/public/source/intershop-pwa/0.1.1/) (2018-06-05)
 
 First public beta release of the Intershop Progressive Web App (intershop-pwa).
 
-# 0.1.0 (2018-05-31)
+## 0.1.0 (2018-05-31)
 
 Initial internal beta release of the Intershop Progressive Web App.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_guide
+kb_everyone
+-->
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_guide
+kb_everyone
+-->
+
 # Contributing to the Intershop Progressive Web App
 
 Thank you for your interest in the Intershop PWA project.

diff --git a/INTERSHOP_CLA.md b/INTERSHOP_CLA.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_everyone
+kb_guide
+-->
+
 # Intershop Contributor License Agreement
 
 Thank you for your interest in contributing to our open source software project ("project PWA storefront" or just "project") made available by Intershop Communications AG ("ISH"). This contributor license agreement ("agreement") sets out the terms governing any source code, object code, bug fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or other works of authorship that you submit or have submitted, in any form and in any manner, to ISH in respect of the project PWA storefront (collectively "Contributions").

diff --git a/README.md b/README.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_guide
+kb_everyone
+-->
+
 # Intershop Progressive Web App
 
 Welcome to the Intershop PWA project!
@@ -12,6 +19,8 @@ More information on the PWA can be found [here](https://www.intershop.com/en/pro
 
 In order to contribute, please have a look at our [Contribution Guidelines](./CONTRIBUTING.md)
 
+## Getting Started
+
 ---
 
 Before working with this project, download and install [Node.js](https://nodejs.org) with the included npm package manager. Currently Node.js 12.x LTS with the corresponding npm is required.
@@ -20,8 +29,6 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
 
 ---
 
-## Quick Start
-
 After having cloned the project from the Git repository, open a command line in the project folder and run `npm install`.
 
 The project uses Angular CLI which has to be installed globally. Run `npm install -g @angular/cli` once to globally install Angular CLI on your development machine. Use `ng serve --open` to start up the development server and open the progressive web app in your browser.

diff --git a/docs/customizations.md b/docs/customizations.md
@@ -1,4 +1,11 @@
-# Intershop Progressive Web App - Customization Guide
+<!--
+kb_sync_by_release
+kb_pwa
+kb_guide
+kb_everyone
+-->
+
+# Customization Guide
 
 When customizing the PWA, always keep in mind that you probably want to upgrade from time to time and will have to merge incoming changes into your codebase. We therefore suggest that you do not edit existing files all too much and keep them as intact as possible. In this document we provide a couple of rules that you should follow. Generally speaking:
 

diff --git a/docs/exclude.properties b/docs/exclude.properties
diff --git a/docs/intershop_progressive_web_app.ditamap b/docs/intershop_progressive_web_app.ditamap
diff --git a/docs/migrations.md b/docs/migrations.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_latest_only
+kb_pwa
+kb_guide
+kb_everyone
+-->
+
 # Migrations
 
 ## 0.16 to 0.17

diff --git a/docs/project-structure.md b/docs/project-structure.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_by_release
+kb_pwa
+kb_concepts
+kb_everyone
+-->
+
 # Project Structure
 
 ## File Name Conventions

diff --git a/docs/search-engine-optimization.md b/docs/search-engine-optimization.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_by_release
+kb_pwa
+kb_concepts
+kb_everyone
+-->
+
 # Search Engine Optimization (SEO)
 
 This section documents our approach for Search Engine Optimization for the Intershop Progressive Web App.

diff --git a/docs/state-management.md b/docs/state-management.md
@@ -1,3 +1,10 @@
+<!--
+kb_sync_by_release
+kb_pwa
+kb_concepts
+kb_everyone
+-->
+
 # State Management
 
 This section describes how [NgRx](https://ngrx.io/) is integrated into the Intershop Progressive Web App for the application wide state management.