From c08e74ac514272e279853461419cdc72863bcce1 Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Mon, 18 Feb 2019 16:47:07 +0100 Subject: [PATCH 1/3] [INTERNAL] ISSUE_TEMPLATE: Reference contributing guidelines and check current component --- .github/ISSUE_TEMPLATE.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 89eb96924..a6a0f8f85 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,3 +1,8 @@ + + ## Expected Behavior {...} @@ -13,16 +18,17 @@ - UI5 Module Version *(output of `ui5 --version` when using the CLI)*: `{...}` - Node.js Version: `{...}` - npm Version: `{...}` -- OS/Platform: {...} -- Browser *(if relevant)*: {...} -- Other information: {...} +- OS/Platform: `{...}` +- Browser *(if relevant)*: `{...}` +- Other information: `{...}` ## Affected components *(if known)* + - [ ] [ui5-builder](https://github.com/SAP/ui5-builder) - [ ] [ui5-server](https://github.com/SAP/ui5-server) - [ ] [ui5-cli](https://github.com/SAP/ui5-cli) - [ ] [ui5-fs](https://github.com/SAP/ui5-fs) -- [ ] [ui5-project](https://github.com/SAP/ui5-project) +- [X] [ui5-project](https://github.com/SAP/ui5-project) - [ ] [ui5-logger](https://github.com/SAP/ui5-logger) ## Log Output / Stack Trace From 2d6efeb86ecfaeac94250e4efa34195e28d10273 Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Mon, 18 Feb 2019 16:54:14 +0100 Subject: [PATCH 2/3] [INTERNAL] Rename UI5 Build and Development Tooling to UI5 Tooling --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- docs/Configuration.md | 4 ++-- jsdoc.json | 8 ++++---- package.json | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19890585e..5c5d4b7f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ -# Contributing to the UI5 Build and Development Tooling +# Contributing to the UI5 Tooling -See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md) repository. \ No newline at end of file +See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md) repository. diff --git a/README.md b/README.md index 4ebc8ecb1..ce4f073ff 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # ui5-project > Modules for building a UI5 projects dependency tree, including configuration. -> Part of the [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling) +> Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling) [![Travis CI Build Status](https://travis-ci.org/SAP/ui5-project.svg?branch=master)](https://travis-ci.org/SAP/ui5-project) [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fproject.svg)](https://www.npmjs.com/package/@ui5/project) diff --git a/docs/Configuration.md b/docs/Configuration.md index 1e619bd6f..47295d418 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,5 +1,5 @@ # Configuration -This document describes the configuration of UI5 Build and Development Tooling based projects and extensions. +This document describes the configuration of UI5 Tooling based projects and extensions. The content represents the **[Specification Version](#specification-versions) `1.0`**. @@ -13,7 +13,7 @@ The content represents the **[Specification Version](#specification-versions) `1 ## Project Configuration Typically located in a `ui5.yaml` file per project. -The preferred way of storing the configuration of a UI5 Build and Development Tooling based project is a [YAML](https://yaml.org/) file named `ui5.yaml` inside that project. +The preferred way of storing the configuration of a UI5 Tooling based project is a [YAML](https://yaml.org/) file named `ui5.yaml` inside that project. **Example** ````yaml diff --git a/jsdoc.json b/jsdoc.json index 0a9afb11b..81925e93c 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -24,10 +24,10 @@ } }, "openGraph": { - "title": "UI5 Build and Development Tooling - API Reference", + "title": "UI5 Tooling - API Reference", "type": "website", "image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png", - "site_name": "UI5 Build and Development Tooling - API Reference", + "site_name": "UI5 Tooling - API Reference", "url": "https://sap.github.io/ui5-tooling/" }, "docdash": { @@ -42,8 +42,8 @@ "Interfaces" ], "meta": { - "title": "UI5 Build and Development Tooling - API Reference - UI5 Project", - "description": "UI5 Build and Development Tooling - API Reference - UI5 Project", + "title": "UI5 Tooling - API Reference - UI5 Project", + "description": "UI5 Tooling - API Reference - UI5 Project", "keyword": "openui5 sapui5 ui5 build development tool api reference" }, "search": true, diff --git a/package.json b/package.json index eb5c59160..eb298769a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@ui5/project", "version": "1.0.1", - "description": "UI5 Build and Development Tooling - Project ", + "description": "UI5 Tooling - Project ", "author": "SAP SE (https://www.sap.com)", "license": "Apache-2.0", "keywords": [ From 8bcb4b13422a6a60fa9670cf051f36fe824bfde8 Mon Sep 17 00:00:00 2001 From: Merlin Beutlberger Date: Mon, 18 Feb 2019 17:04:33 +0100 Subject: [PATCH 3/3] [INTERNAL] README: Reference UI5 CLI docs in other modules --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce4f073ff..8239e901b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/master/docs/images/UI5_logo_wide.png) # ui5-project -> Modules for building a UI5 projects dependency tree, including configuration. +> Modules for building a projects dependency tree, including UI5 specific configuration. > Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling) [![Travis CI Build Status](https://travis-ci.org/SAP/ui5-project.svg?branch=master)](https://travis-ci.org/SAP/ui5-project) @@ -10,6 +10,8 @@ [![Dependency Status](https://david-dm.org/SAP/ui5-project/master.svg)](https://david-dm.org/SAP/ui5-project/master) [![devDependency Status](https://david-dm.org/SAP/ui5-project/master/dev-status.svg)](https://david-dm.org/SAP/ui5-project/master#info=devDependencies) +**⌨️ CLI reference can be found [here!](https://github.com/SAP/ui5-cli#cli-usage)** + ## Configuration See [Configuration](docs/Configuration.md).