From b89b8c673afdf37d4687c3e7bcc02b1dbb06d772 Mon Sep 17 00:00:00 2001 From: Judith de la Fuente Date: Fri, 6 Nov 2020 12:56:48 +0100 Subject: [PATCH] tiny changes fix some links --- CONTRIBUTING.md | 4 +-- README.md | 6 ++-- docs/README.md | 2 +- docs/acknowledgments.md | 2 +- docs/concepts.md | 10 +++--- docs/contributing/application-architecture.md | 26 +++++++------- .../getting-started-developers.md | 34 +++++++++---------- docs/contributing/templates.md | 4 +-- .../services/azure-appservice.md | 12 +++---- docs/generated-apps/services/azure-cosmos.md | 20 ++++++----- docs/install.md | 4 +-- docs/telemetry.md | 10 +++--- 12 files changed, 68 insertions(+), 66 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3f3930eb..6b01c3e07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ # Contributing to Web Template Studio -The foundation of _Web Template Studio_ is to get developers up and running with a new +The foundation of *Web Template Studio* is to get developers up and running with a new web app that incorporates cloud services on Azure as fast as possible. -Using Web Template Studio, a developer can select their preferred web +Using *Web Template Studio*, a developer can select their preferred web frameworks, pages and Azure cloud services to generate boilerplate code for their web app. The generated code not only follows best practices and design guidelines, but also includes comments to guide the developer through the logic and adding functionality to diff --git a/README.md b/README.md index 393176117..b51349588 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Platforms Supported: MacOSX, Linux, Windows Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: We are using the MIT License We are welcoming PRS! -Microsoft Web Template Studio (_WebTS_) is a Visual Studio Code Extension that accelerates the creation of new web applications using a +Microsoft *Web Template Studio* (aka *WebTS*) is a Visual Studio Code Extension that accelerates the creation of new web applications using a wizard-based experience. WebTS enables developers to generate boilerplate code for a web application by choosing between different frontend frameworks, backend frameworks, pages and cloud services. The resulting web app is well-formed, readable code that incorporates cloud services on @@ -76,7 +76,7 @@ I need a full-stack web app that is deployed on Azure App Service Web App. ## Features -Web Template Studio approaches full-stack web app creation using the following three attribute sets: +*Web Template Studio* approaches full-stack web app creation using the following three attribute sets: - **Frameworks**: First, which frameworks do you want to use for your frontend and backend? We currently support three frameworks for frontend: _[React](https://reactjs.org/)_, _[Angular](https://angular.io/)_, _[Vue.js](https://vuejs.org/)_ and four frameworks for backend: _[Node](https://nodejs.org/en/)_, _[Flask](http://flask.pocoo.org/)_, _[Moleculer](https://moleculer.services/)_ and _[ASP.NET Core](https://dotnet.microsoft.com/apps/aspnet)_. We also provide a dependency checker to make sure you have the required version of Node, Python and/or .NET Core installed. - **App pages**: Next, to accelerate app creation, we provide a number of app page templates that you can use to add common UI pages into your new app. The current page templates include: _blank page_, common layouts (*e.g., master detail) and pages that implement common patterns (*e.g., grid, list). Using the wizard, add as many of the pages as you need, providing a name for each one, and we'll generate them for you. @@ -126,4 +126,4 @@ The extension does [log basic telemetry](docs/telemetry.md) for what is being se ## Acknowledgments -Microsoft Web Template Studio was [initially created by Microsoft Garage interns](docs/acknowledgments.md). We hope many more continue with the project +Microsoft *Web Template Studio* was [initially created by Microsoft Garage interns](docs/acknowledgments.md). We hope many more continue with the project. diff --git a/docs/README.md b/docs/README.md index e1e53bc7a..f1bb42ebb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ # Documentation -Web Template Studio (WebTS) documentation is divided into three areas. +*Web Template Studio* (WebTS) documentation is divided into three areas. ## General diff --git a/docs/acknowledgments.md b/docs/acknowledgments.md index d35f41631..21e692e1b 100644 --- a/docs/acknowledgments.md +++ b/docs/acknowledgments.md @@ -1,6 +1,6 @@ # Acknowledgments -Microsoft Web Template Studio was initially built by two great groups of interns from the Microsoft Garage. This full list of individuals that helped build the project. +Microsoft *Web Template Studio* was initially built by two great groups of interns from the Microsoft Garage. This full list of individuals that helped build the project. ## First group (first quarter of 2019): diff --git a/docs/concepts.md b/docs/concepts.md index 0ee5742b9..70e1232a7 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,15 +1,15 @@ # Concepts of Web Template Studio -This section outlines the main concepts and definitions used in Web Template Studio. +This section outlines the main concepts and definitions used in *Web Template Studio*. ## Main concepts -Web Template Studio is divided in the following main elements: +*Web Template Studio* is divided in the following main elements: -- **Extension**: Refers to the Visual Studio Code Extension project, which, once installed, allows users to have an improved experience when creating a new Web Application from the "Web Template Studio: Launch" command. The extension is written in typescript. -- **Wizard**: Refers to the WebTS client project, where all user interaction occurs after launching Web Template Studio. The Wizard guides the user through some steps to create the desired project. It allows the user to select from the available frameworks, pages and Azure Cloud Services. The wizard is created with React Typescript and is displayed through the React Panel. +- **Extension**: Refers to the Visual Studio Code Extension project, which, once installed, allows users to have an improved experience when creating a new Web Application from the `Web Template Studio: Launch` command. The extension is written in typescript. +- **Wizard**: Refers to the WebTS client project, where all user interaction occurs after launching *Web Template Studio*. The Wizard guides the user through some steps to create the desired project. It allows the user to select from the available frameworks, pages and Azure Cloud Services. The wizard is created with React Typescript and is displayed through the React Panel. - **Core Template Studio and Core Template Studio CLI**: Refers to the .NET Core executable that handles all of the template synchronization and code generation (composition, generation + postaction execution). The CLI is the entry point for executing commands on Core Template Studio executable. CoreTS CLI is a self-contained .NET Core 3.1 application. -- **Template**: A template contains code with metadata. The metadata will contain the following template information: name, description, licensing, remarks, programming language, type, etc. The template definition is based on [dotnet Template Engine](https://github.com/dotnet/templating). [More details on templates](/contributing/templates.md) +- **Template**: A template contains code with metadata. The metadata will contain the following template information: name, description, licensing, remarks, programming language, type, etc. The template definition is based on [dotnet Template Engine](https://github.com/dotnet/templating). [More details on templates](../contributing/templates.md) ## Other Terminology diff --git a/docs/contributing/application-architecture.md b/docs/contributing/application-architecture.md index 06c3fdbd4..50789567f 100644 --- a/docs/contributing/application-architecture.md +++ b/docs/contributing/application-architecture.md @@ -1,6 +1,6 @@ # Application Architecture -Web Template Studio is a [Visual Studio Code Extension](https://code.visualstudio.com/api) that has three major components. All of them are included in Web Template Studio **vsix**: +*Web Template Studio* is a [Visual Studio Code Extension](https://code.visualstudio.com/api) that has three major components. All of them are included in *Web Template Studio* **vsix**: 1. The [extension's backend](#extension) (referred to as the [extension](../../src/extension)). Written in [Typescript](https://www.typescriptlang.org/). 1. The [frontend wizard](#client) (referred to as the [client](../../src/client)). Written in [React](https://reactjs.org/) and [Typescript](https://www.typescriptlang.org/). @@ -13,26 +13,26 @@ Web Template Studio is a [Visual Studio Code Extension](https://code.visualstudi ## Extension -The extension is the main part of Web Template Studio. It has been built using the [Visual Studio Code Extensibility API](https://code.visualstudio.com/api) to build extensions. It is responsible for launching the client in a Visual Studio Code tab and for communication between the wizard client and the Core Template Studio CLI. It is also responsible for creating the Azure Services (App Service and CosmosDB Service) and the deployment of the generated applications. +The extension is the main part of *Web Template Studio*. It has been built using the [Visual Studio Code Extensibility API](https://code.visualstudio.com/api) to build extensions. It is responsible for launching the client in a Visual Studio Code tab and for communication between the wizard client and the Core Template Studio CLI. It is also responsible for creating the Azure Services (App Service and CosmosDB Service) and the deployment of the generated applications. It contains two commands that can be called from Visual Studio Code: -- [webTemplateStudioExtension.wizardLaunch](https://github.com/microsoft/WebTemplateStudio/blob/dev/src/extension/src/extension.ts#L7-L11): This command is executed when we launch the "Web Template Studio: Launch" command from Visual Studio Code. It is responsible to start the Core Template Studio CLI in a `child_process`, synchronizing the templates and opening the wizard in a Visual Studio Code tab. While the wizard is open, it is also responsible for maintaining communication between the wizard client and the Core Template Studio CLI to obtain templates and generate projects. - -- [webTemplateStudioExtension.deployApp](https://github.com/microsoft/WebTemplateStudio/blob/dev/src/extension/src/extension.ts#L13-L18): This command is executed when we launch the "Web Template Studio: Deploy App" command from Visual Studio Code. It is responsible for deploying a generated application in Azure.
-**Note**: For this command to work properly, we need a web application generated with Web Template Studio opened and configured with an App Service. +- [webTemplateStudioExtension.wizardLaunch](https://github.com/microsoft/WebTemplateStudio/blob/dev/src/extension/src/extension.ts#L7-L11): This command is executed when we launch the `Web Template Studio: Launch` command from Visual Studio Code. It is responsible to start the Core Template Studio CLI in a `child_process`, synchronizing the templates and opening the wizard in a Visual Studio Code tab. While the wizard is open, it is also responsible for maintaining communication between the wizard client and the Core Template Studio CLI to obtain templates and generate projects. + +- [webTemplateStudioExtension.deployApp](https://github.com/microsoft/WebTemplateStudio/blob/dev/src/extension/src/extension.ts#L13-L18): This command is executed when we launch the `Web Template Studio: Deploy App` command from Visual Studio Code. It is responsible for deploying a generated application in Azure.
+**Note**: For this command to work properly, we need a web application generated with *Web Template Studio* opened and configured with an App Service. ## Client -The wizard client is the visual component of the extension. It is a [React](https://reactjs.org/) app that is compiled into JavaScript that gets injected into html, which then gets served using [VSCode's Webview API](https://code.visualstudio.com/api/extension-guides/webview). It is shown in a Visual Studio Code tab when the user executes the "Web Template Studio: Launch" extension command. +The wizard client is the visual component of the extension. It is a [React](https://reactjs.org/) app that is compiled into JavaScript that gets injected into html, which then gets served using [VSCode's Webview API](https://code.visualstudio.com/api/extension-guides/webview). It is shown in a Visual Studio Code tab when the user executes the `Web Template Studio: Launch` extension command. It is responsible for the interaction with the user and is responsible for collecting the name and route of the project, the selected frameworks, pages and services and sending them to the extension for processing with Core Template Studio. The wizard client keeps track of the state using [Redux](https://react-redux.js.org/). ### Color Themes -Web Template Studio supports Visual Studio Code's **light, dark, and high contrast theme**. You can press `Ctrl + K` then `Ctrl + T` in Windows/Linux or `Command ⌘ + K` then `Command ⌘ + T` in Mac to choose different color themes in Visual Studio Code. +*Web Template Studio* supports Visual Studio Code's **light, dark, and high contrast theme**. You can press `Ctrl + K` then `Ctrl + T` in Windows/Linux or `Command ⌘ + K` then `Command ⌘ + T` in Mac to choose different color themes in Visual Studio Code. #### Example of Light Theme: @@ -93,13 +93,13 @@ To see the Core Template Studio CLI available commands visit [Core Template Stud ### Client send to extension When the client wants to execute an extension command, it will call `vscode.postMessage()` function, passing through parameters an object with the following properties: -``` + - module: extension module that should process this request. - command: extension command that should process the request. - payload: data that we send in the request. -``` - Example: + +#### Example: ```js vscode.postMessage({ @@ -145,10 +145,10 @@ Messages sent from the extension are received in the `messageEventsFromExtension ### Extension send to client When the extension needs to send a request to the client, it will call `postMessageWebview()` function in [reactPanel.ts](https://github.com/microsoft/WebTemplateStudio/blob/dev/src/extension/src/reactPanel.ts). This function communicates with the webview that contains the client, passing through parameters an object with the following properties: -``` + - command: extension command that processed the request. - payload: data that we send in the request. -``` + #### Example: ```js diff --git a/docs/contributing/getting-started-developers.md b/docs/contributing/getting-started-developers.md index a5336db08..3950443bf 100644 --- a/docs/contributing/getting-started-developers.md +++ b/docs/contributing/getting-started-developers.md @@ -1,7 +1,7 @@ -# Getting started developers -To contribute to Web Template Studio. +# Getting started developers +To contribute to *Web Template Studio*. -If you are authoring templates for Web Template Studio, or interested in contributing to this repo, then you are likely interested in how to use the latest version of this code. +If you are authoring templates for *Web Template Studio*, or interested in contributing to this repo, then you are likely interested in how to use the latest version of this code. This document covers: - [Prerequisites](#prerequisites) @@ -15,7 +15,7 @@ This document covers: Before starting make sure you read the [Web Template Studio arquitecture](application-architecture.md) document. -If you just want to take advantage from Web Template Studio extension, check the [Web Template Studio Installation Instructions page](../install.md). +If you just want to take advantage from *Web Template Studio* extension, check the [Web Template Studio Installation Instructions page](../install.md). ## Prerequisites @@ -29,12 +29,12 @@ If you just want to take advantage from Web Template Studio extension, check the 8. Install [React-scripts]() globally `npm install -g react-scripts` 9. Run the command `npm config set scripts-prepend-node-path true`. This tells VSCode which Node version to run during the extension compilation (otherwise you'll get an error during the build process). -**Note*: If using Windows, use Git Bash.* +**Note**: If using Windows, use Git Bash. ## Project folder structure ### `src` folder -This folder contains the source code for the different components of Web Template Studio. +This folder contains the source code for the different components of *Web Template Studio*. - [`client`](../../src/client): This folder contains the client or wizard code. - `src`: @@ -57,7 +57,7 @@ This folder contains the source code for the different components of Web Templat - `telemetry`: contains all functionality related to telemetry. - `utils`: contains helper functions as logger and validators. -- [`CoreTemplateStudio`](../../src/CoreTemplateStudio): This solution contains the Core Template Studio code. +- `CoreTemplateStudio`: This solution contains the Core Template Studio code. For more information on internal structure, see [Core Template Studio docs](https://github.com/microsoft/CoreTemplateStudio/blob/dev/docs/getting-started-developers.md). @@ -70,18 +70,18 @@ This folder will contain the .vsix if generated. ### `templates` folder This folder contains the templates that are used to generate the code. For more info on templates see [Understanding the Templates](templates.md). -### `templates_-_test` folder -This folder will contain all the combination of possible generated applications when running the script "*template-tests*" existing on the extension. +### `template-test` folder +This folder will contain all the combination of possible generated applications when running the script "**template-tests**" existing on the extension. ## Core Template Studio Submodule -Web Template Studio relies on Core Template Studio for template synchronization and template composition, generation and postaction. Core Template Studio has its [own Github repository](github.com/Microsoft/CoreTemplateStudio) as it is shared with the sibling project [Windows Template Studio](github.com/Microsoft/WindowsTemplateStudio). +*Web Template Studio* relies on Core Template Studio for template synchronization and template composition, generation and postaction. Core Template Studio has its [own Github repository](github.com/Microsoft/CoreTemplateStudio) as it is shared with the sibling project [Windows Template Studio](github.com/Microsoft/WindowsTemplateStudio). -Core Template Studio is integrated into Web Template Studio using a git submodule under the folder [CoreTemplateStudio](../src/CoreTemplateStudio). The submodule points to a specific commit in Core Template Studio, that you can see in github: +Core Template Studio is integrated into *Web Template Studio* using a git submodule under the folder [CoreTemplateStudio](../src/CoreTemplateStudio). The submodule points to a specific commit in Core Template Studio, that you can see in github: Core Template Studio Submodule ### Init /update -When you clone Web Template Studio you have to run two commands: `git submodule init` and `git submodule update` to fetch all the data from Core Template Studio. When fetching changes, also execute `git submodule update` after doing git fetch to be sure you're submodule is up to date. +When you clone *Web Template Studio* you have to run two commands: `git submodule init` and `git submodule update` to fetch all the data from Core Template Studio. When fetching changes, also execute `git submodule update` after doing git fetch to be sure you're submodule is up to date. ### Update with remote changes Changes on Core Template Studio should be done on the Core Template Studio repos. In WebTS, to update the submodule to the most recent commit, you have to run the command: `git submodule update --remote`. @@ -119,8 +119,8 @@ Install [Debugger for Chrome extension](https://marketplace.visualstudio.com/ite After starting the client using `yarn start` in VSCode Debug View (`Ctrl + Shift ⇧ + D` (Windows/Linux) or `Shift ⇧ + Command ⌘ + D` (Mac) in Visual Studio Code) select "*Debug WebTS Client*" and start debugging (`F5`). #### More info: -- https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome -- https://code.visualstudio.com/docs/editor/debugging +- [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) +- [Debugging in Visual Studio Code](https://code.visualstudio.com/docs/editor/debugging) ## How to built a local vsix Run `./createLocalVsix.sh` from the `_build` folder. @@ -133,7 +133,7 @@ code --install-extension [extensionName].vsix `webts-0.0.0-UNTRACKEDVERSION.vsix` is the default extensionName. -Alternatively, the extension can be installed from the context menu of the extension section in Visual Studio code using the "**install from VSIX...**" command. The installed vsix package can be found in the extensions folder. For _Windows_, it is `%USERPROFILE%\.vscode\extensions`. For _Mac/Linux_, it is `~/.vscode/extensions` (By Default). +Alternatively, the extension can be installed from the context menu of the extension section in Visual Studio code using the "**install from VSIX...**" command. The installed vsix package can be found in the extensions folder. For *Windows*, it is `%USERPROFILE%\.vscode\extensions`. For *Mac/Linux*, it is `~/.vscode/extensions` (By Default). After installation, use `Ctrl + Shift ⇧ + P` (Windows/Linux) or `Command ⌘ + Shift ⇧ + P` (Mac) in Visual Studio Code to open the Extension Launcher and select `Web Template Studio: Launch` to run the extension. @@ -149,11 +149,11 @@ To run the client tests, go to `src/client` and run `yarn test` to run all the t - [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) ### Template Tests -Currently we use scripts to test the generated code. The [scripts](..\src\extension\src\scripts) are located in the folder `..\src\extension\src\scripts`. +Currently we use scripts to test the generated code. The scripts are located in [src/extension/src/scripts](../../src/extension/src/scripts). The **generate-tests** script generates all the different permutations of a Fullstack project (without azure services). Afterwards the **run-tests** script *installs the dependencies* for the generated project, runs *yarn start*, *yarn lint* and *yarn test* on all the generated projects. -To run the template tests go to [the extension folder](..\src\extension\) and run `yarn template-tests` to run the tests. +To run the template tests go to the [`extension` folder](../../src/extension) and run `yarn template-tests` to run the tests. ## Under the Hood diff --git a/docs/contributing/templates.md b/docs/contributing/templates.md index 087b3b781..3c8e72dcc 100644 --- a/docs/contributing/templates.md +++ b/docs/contributing/templates.md @@ -1,13 +1,13 @@ # Understanding the Templates -Templates are used to generate the code. In Web Template Studio we have the following kinds of templates: Frameworks, Projects Types, Pages and Features. +Templates are used to generate the code. In *Web Template Studio* we have the following kinds of templates: Frameworks, Projects Types, Pages and Features. For example, consider the following scenarios: - **Scenario #1**: you want to generate a project to create a target web app which uses the *React* on the frontend and *Node* on the backend, with some pages (Home, Products -a master detail page-, Todo -a list page-, etc. ) and including some extra features like Azure App Service and Cosmos DB... - **Scenario #2**: you want to create as in *Scenario #1* but with Angular as frontend framework and without CosmosDB support. -The Web Template Studio allow you to combine different templates to generate the project you want, using your preferred framework, and using the features you most like. Moreover, the templates available in Web Template Studio are extensible. +The *Web Template Studio* allow you to combine different templates to generate the project you want, using your preferred framework, and using the features you most like. Moreover, the templates available in *Web Template Studio* are extensible. ## Interested in contributing diff --git a/docs/generated-apps/services/azure-appservice.md b/docs/generated-apps/services/azure-appservice.md index f207fa3e2..6e6110f2a 100644 --- a/docs/generated-apps/services/azure-appservice.md +++ b/docs/generated-apps/services/azure-appservice.md @@ -2,11 +2,11 @@ *Azure App Service* is an HTTP-based service for hosting web applications, REST APIs, and mobile backends. You can develop in your favorite language, be it .NET, .NET Core, Java, Ruby, Node.js, PHP, or Python. Applications run and scale with ease on both Windows and Linux-based environments. For more info about *Azure App Service* click [here](https://docs.microsoft.com/azure/app-service/overview). -Web Template Studio offers you the functionality to create and deploy your application to *Azure App Service* from the wizard quickly and easly. +*Web Template Studio* offers you the functionality to create and deploy your application to *Azure App Service* from the wizard quickly and easly. ## Getting started -To create an *Azure App Service* using Web Template Studio: +To create an *Azure App Service* using *Web Template Studio*: Navigate to the "**Add Optional Cloud Services**" step. Click the "**Add to my project**" button in the **App Service card**. @@ -22,7 +22,7 @@ Enter a **Web App Name** for your azure web app. It must be a unique app name th ### Advanced mode -By default, Web Template Studio deploys the App Service in the location Central US and creates a Resource Group with the same name as the web app. It will also create the *free BASIC App Service Plan* that hosts the web app. [More info for App Service Plans](https://azure.microsoft.com/en-us/pricing/details/app-service/plans/). +By default, *Web Template Studio* deploys the App Service in the location Central US and creates a Resource Group with the same name as the web app. It will also create the *free BASIC App Service Plan* that hosts the web app. [More info for App Service Plans](https://azure.microsoft.com/en-us/pricing/details/app-service/plans/). We can change these settings using the *advanced mode*. To display it, click on the "**Advanced mode**" link and the App Service modal will show two new configuration options: @@ -33,9 +33,9 @@ We can change these settings using the *advanced mode*. To display it, click on Azure Create App Service in Advanced Mode ## Creating App Service -Once you hit generate on the summary page, Web Template Studio will create an *Azure App Service* that will be accessible from `http://.azurewebsites.net`. +Once you hit generate on the summary page, *Web Template Studio* will create an *Azure App Service* that will be accessible from `http://.azurewebsites.net`. -Web Template Studio uses an arm-template for *Azure App Service*s (generated under the arm-templates directory). This template contains the definitions and parameters for all resources that need to deploy. Once Azure receives your template, it takes about 2-3 minutes to create the App Service and the App Service Plan. The app service initially contains an empty web app. +*Web Template Studio* uses an arm-template for *Azure App Service*s (generated under the arm-templates directory). This template contains the definitions and parameters for all resources that need to deploy. Once Azure receives your template, it takes about 2-3 minutes to create the App Service and the App Service Plan. The app service initially contains an empty web app. ***Note for advanced users***: The *arm templates* used to deploy your application, are also available under the *arm-templates* directory in your generated project. @@ -45,6 +45,6 @@ When we create a *Azure App Service*, it initially contains an empty web app. To ## VSCode Extension for Azure App Service -To manage *Azure App Service* you can use the [Azure App Service extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice), which is automatically installed with Web Template Studio. +To manage *Azure App Service* you can use the [Azure App Service extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice), which is automatically installed with *Web Template Studio*. This extension helps you create, manage, and deploy your websites quickly. diff --git a/docs/generated-apps/services/azure-cosmos.md b/docs/generated-apps/services/azure-cosmos.md index 89bcfcc2e..46f272013 100644 --- a/docs/generated-apps/services/azure-cosmos.md +++ b/docs/generated-apps/services/azure-cosmos.md @@ -2,16 +2,16 @@ *Azure Cosmos DB* is Microsoft’s proprietary globally-distributed, multi-model database service for managing data on a global scale. It offers a variety of APIs for your database including Azure Table, Core (SQL), MongoDB and Gremlin -(GraphQL). +(GraphQL). -**Web Template Studio** offers you the functionality to deploy a Cosmos DB instance from the wizard itself +*Web Template Studio* offers you the functionality to deploy a Cosmos DB instance from the wizard itself and select an initial location to deploy your database with the ability to scale it to multiple locations at a future -time. As an added feature, deploying with the MongoDB API enables you to quickly connect the project **Web Template Studio** +time. As an added feature, deploying with the MongoDB API enables you to quickly connect the project *Web Template Studio* generates to your database instance. ## Getting started -To deploy Cosmos DB using **Web Template Studio**: +To deploy Cosmos DB using *Web Template Studio*: Navigate to the "**Add Optional Cloud Services**" step. Click the "**Add to my project**" button in **CosmosDB card**. @@ -24,13 +24,15 @@ Select a **Subscription** from the **Create Cosmos DB Account** modal that just Enter an **Account Name** for your cosmos account. This name is globally unique since your database will be available as `.documents.azure.com`. -Select an API for your database. ***Note***: **Web Template Studio** only supports MongoDB API and SQL API. +Select an API for your database. + +**Note**: *Web Template Studio* only supports MongoDB API and SQL API. Azure Cosmos Create Modal ### Advanced mode -By default, **Web Template Studio** deploys the Cosmos DB in the location Central US and creates a Resource Group with the same name as the web app. +By default, *Web Template Studio* deploys the Cosmos DB in the location Central US and creates a Resource Group with the same name as the web app. We can change these settings using the *advanced mode*. To access those, click on the "Advanced mode" link and the Cosmos DB modal will show two new configuration options. @@ -42,7 +44,7 @@ We can change these settings using the *advanced mode*. To access those, click o ## Creating Cosmos DB -Once you hit **Create Project**, **Web Template Studio** will deploy your database and display a popup with your +Once you hit **Create Project**, *Web Template Studio* will deploy your database and display a popup with your database connection string once it's available (usually within 5-6 minutes). This will prompt you to replace the connection string in your configuration file with the new connection string. @@ -56,10 +58,10 @@ The generated project stores API keys in the `.env` file (`appsettings.json` for ## How this works -**Web Template Studio** uses an arm-template for Cosmos to deploy your Cosmos DB instance. This is generated under the `arm-templates` directory. +*Web Template Studio* uses an arm-template for Cosmos to deploy your Cosmos DB instance. This is generated under the `arm-templates` directory. This template contains the definitions and parameters for all resources and storage accounts that need to be created for your database. Once Azure receives your template, it takes about 5-6 minutes to assign VMs for your database account, get them up and running with your selected API and have the database connection string available for you to connect to your database. -Once the connection string is available, **Web Template Studio** will prompt you to replace the variables in your `.env/appsettings.json` file with this string and your keys. +Once the connection string is available, *Web Template Studio* will prompt you to replace the variables in your `.env/appsettings.json` file with this string and your keys. ***Warning***: Accepting this prompt will override your current `.env/appsettings.json`. If you have made any changes to this file, consider saving them! You will also need to restart your server to sync changes on your configuration diff --git a/docs/install.md b/docs/install.md index 3f7e76ae2..e8114a738 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,7 +2,7 @@ ## Prerequisites -Web Template Studio runs as a VSCode extension and hence you'll need to have *VScode* version 1.38 or above installed. +*Web Template Studio* runs as a VSCode extension and hence you'll need to have *VScode* version 1.38 or above installed. Also, you'll need [node](https://nodejs.org/en/download/), [python](https://www.python.org/downloads/) or [ASP.NET](https://dotnet.microsoft.com/download) and [npm](https://www.npmjs.com/get-npm)/[yarn](https://yarnpkg.com/en/docs/install) to run the generated templates. ## Installing the official release @@ -19,7 +19,7 @@ Head over to [Visual Studio Marketplace’s Web Template Studio page](https://ma 4. Open the extensions menu from VSCode sidebar 5. Click on the ellipsis in the upper right hand corner 6. Choose *Install from VSIX* -7. Select the `.vsix` you downloaded earlier. Web Template Studio is now ready to use +7. Select the `.vsix` you downloaded earlier. *Web Template Studio* is now ready to use VSIX Install Instructions diff --git a/docs/telemetry.md b/docs/telemetry.md index 8db0ec16e..f862fbd5e 100644 --- a/docs/telemetry.md +++ b/docs/telemetry.md @@ -1,10 +1,10 @@ # Web Template Studio Telemetry -Web Template Studio logs usage data and diagnostics telemetry through [Application Insights](https://azure.microsoft.com/en-us/services/monitor/). +*Web Template Studio* logs usage data and diagnostics telemetry through [Application Insights](https://azure.microsoft.com/en-us/services/monitor/). The class [TelemetryService](../src/extension/src/telemetry/telemetryService.ts), within the extension code, isolates the telemetry service implementation details and offers a smooth and easy way to invoke telemetry events. -Apart from the data logged in Web Template Studio, Core Template Studio tracks telemetry data on generation. For more info see [Core Template Studio Telemetry](https://github.com/microsoft/CoreTemplateStudio/blob/dev/docs/telemetry.md) +Apart from the data logged in *Web Template Studio*, Core Template Studio tracks telemetry data on generation. For more info see [Core Template Studio Telemetry](https://github.com/microsoft/CoreTemplateStudio/blob/dev/docs/telemetry.md) ## Trends @@ -12,7 +12,7 @@ Please head to our [Telemetry Data](telemetryData.md) where we show trends from ## Telemetry Gathered -The wizard for Web Template Studio collects basic diagnostics telemetry and usage data: +The wizard for *Web Template Studio* collects basic diagnostics telemetry and usage data: - **Diagnostics telemetry:** Unhandled error and exceptions that happened while running the wizard are logged with Application Insights. This includes the stack trace of the error @@ -20,7 +20,7 @@ The wizard for Web Template Studio collects basic diagnostics telemetry and usag ## Usage Telemetry -Through the Application Insights API, telemetry events are collected to gather basic information regarding Web Template Studio extension usage. The following table describes the Telemetry Events we collect: +Through the Application Insights API, telemetry events are collected to gather basic information regarding *Web Template Studio* extension usage. The following table describes the Telemetry Events we collect: |Event Name Tracked |Notes | |:-------------:|:-----| @@ -29,7 +29,7 @@ Through the Application Insights API, telemetry events are collected to gather b |**Sync-Engine**|Track the time it takes to synchronize the templates in the extension| |**Create-New-Project**|Track the start of creating a new project. Save the entry-point of this action (Launch wizard or Create New Project button).| |**Wizard-To-Generate-Session-Time**|Track the time that elapses since the extension is launched until the start generation a new project.| -|**Wizard-Page-Change**|Track the total time the user views a Web Template Studio extension page.| +|**Wizard-Page-Change**|Track the total time the user views a *Web Template Studio* extension page.| |**login**|Track the time it takes for a user to log in to Azure.| |**logout**|Track the time it takes for a user to log out of their Azure account.| |**get-user-status**|Track the time it takes for the extension to obtain the data of a user logged in to Azure.|