Skip to content

Commit 7557b8e

Browse files
committed
Polishing upcoming scenario guidance documentation
1 parent a47a3e3 commit 7557b8e

File tree

6 files changed

+151
-38
lines changed

6 files changed

+151
-38
lines changed

docs/scenario-guidance/Application-lifecycle-management.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Scenario Guidance - Application Lifecycle Management
3+
description: Scenario guidance on application lifecycle management topics with SharePoint Framework and SharePoint add-ins.
4+
ms.date: 03/26/2018
5+
---
6+
17
# Application Lifecycle Management
28

39
## Summary

docs/scenario-guidance/Branding.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
---
2-
title: Branding
3-
ms.date: 01/18/2018
2+
title: Scenario Guidance - Branding
3+
description: Scenario guidance on branding options with SharePoint.
4+
ms.date: 03/26/2018
45
---
6+
57
# Branding
68

79
## Summary
810

9-
There are many different reasons why you would apply custom branding to a SharePoint site. These reasons can include corporate identity, usability, marketing, etc. Office 365 SharePoint sites support customized branding. Resources in this section will help you consider the short and long-term impact of customization from an operational and a maintenance perspective. This is not really specific for SharePoint; but is rather a rule of thumb for any IT solution built with any platform.
11+
There are many different reasons why you would apply custom branding to a SharePoint site. These reasons can include corporate identity, usability, marketing, etc. SharePoint Online sites support customized branding, but options are slightly different than with SharePoint on-premises deployments.
12+
13+
Resources in this article will help you consider the short and long-term impact of customization from an operational and a maintenance perspective. Guidance around the long term impact analyzes is not really specific for SharePoint; but is rather a rule of thumb for any IT solution built with any platform.
1014

1115
## High-level guideline/general rules
1216

1317
- Office 365 is being updated frequently. To be able to benefit of the latest capabilities, use only the recommended approaches to brand SharePoint Online
14-
- When customizing SharePoint user experience through DOM manipulation, custom CSS or custom master pages and page layouts, after applying each SharePoint patch, verify that your customizations are still working as expected and don't collide with any of the changes introduced in the patch
18+
- When customizing SharePoint user experience through DOM manipulation, custom CSS or custom master pages and page layouts, after applying each SharePoint update, verify that your customizations are still working as expected and don't collide with any of the changes introduced withing the installed updates.
1519

1620
## Available options
1721

@@ -36,17 +40,23 @@ In 2016, the SharePoint Online team released "modern" collaboration sites. These
3640
- Create custom site columns (fields) and content types.
3741
- Create lists and libraries.
3842
- Configure site settings, such as regional settings, languages, and auditing settings.
43+
- Use SharePoint Framework extensions to provide user interface components and controls.
44+
- Use Hub Sites capability to provide cross site collection navigation capability.
3945

4046
#### Related resources
4147

4248
##### Articles
4349

4450
- [Customizing the "modern" experiences in SharePoint Online](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/modern-experience-customizations)
51+
- [SharePoint Site Theming (modern)](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)
52+
- [Overview of programming SharePoint hub sites](https://docs.microsoft.com/en-us/sharepoint/dev/features/hub-site/hub-site-overview)
4553
- [New site theming options for SharePoint sites in Office 365](https://techcommunity.microsoft.com/t5/SharePoint-Blog/New-site-theming-options-for-SharePoint-sites-in-Office-365/ba-p/94001)
4654
- [Change the look of your SharePoint site](https://support.office.com/en-us/article/Change-the-look-of-your-SharePoint-site-06bbadc3-6b04-4a60-9d14-894f6a170818)
55+
- [Overview of SharePoint Framework Extensions](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/extensions/overview-extensions)
4756

4857
##### Solutions
4958

59+
- [SharePoint Framework Extension samples](https://github.com/SharePoint/sp-dev-fx-extensions)
5060
- [SharePoint "Modern" user interface experience scanner](https://github.com/SharePoint/PnP-Tools/tree/master/Solutions/SharePoint.UIExperience.Scanner)
5161

5262
##### Videos
@@ -123,7 +133,7 @@ Composed looks are out-of-the-box themes that are included in SharePoint 2013 an
123133

124134
_**Applies to:** Classic sites_
125135

126-
Design Manager is a feature in SharePoint that makes it easier to create a fully customized, pixel-perfect design while using the web-design tools that you're already familiar with. Design Manager is a publishing feature that is available in publishing sites in both SharePoint and Office 365.
136+
Design Manager is a feature in SharePoint that makes it easier to create a fully customized, pixel-perfect design while using the web-design tools that you're already familiar with. Design Manager is a publishing feature that is available in classic publishing sites in both SharePoint and Office 365.
127137

128138
With Design Manager, you can create a visual design for your website by using whatever web design tool or HTML editor you prefer, using only HTML and CSS, and then upload that design into SharePoint. Design Manager is the central hub and interface where you manage all aspects of a custom design.
129139

@@ -199,6 +209,7 @@ Cascading style sheet (CSS) plays a large role in SharePoint branding. To succes
199209

200210
- [SharePoint 2013/2016/Online Responsive UI](https://github.com/SharePoint/PnP-Tools/tree/master/Solutions/SharePoint.UI.Responsive)
201211
- [Activate the PnP Responsive UI Add-on using PnP PowerShell](https://msdn.microsoft.com/en-us/pnp_powershell/enablepnpresponsiveui)
212+
- [CSS Injection Pattern sample](https://github.com/SharePoint/PnP/tree/master/Samples/Branding.CustomCSS)
202213
- [SharePoint "Modern" user interface experience scanner](https://github.com/SharePoint/PnP-Tools/tree/master/Solutions/SharePoint.UIExperience.Scanner)
203214
- [Transformation tool](https://github.com/SharePoint/PnP-Transformation/tree/master/Transformation%20Tool%20-%20CSOM#introduction)
204215

@@ -208,10 +219,12 @@ Cascading style sheet (CSS) plays a large role in SharePoint branding. To succes
208219
- [AlternateCssUrl & SiteLogoUrl properties in web object](https://dev.office.com/patterns-and-practices-detail/1849)
209220
- [Making out of the box Seattle master responsive](https://dev.office.com/patterns-and-practices-detail/5823)
210221

211-
### Script injection and DOM manipulation
222+
### Script Embedding and DOM manipulation
212223

213224
_**Applies to:** Classic sites_
214225

226+
Script Embedding means a pattern where custom JavaScript is added on the page which then modifies the end user experiences by modifying the html DOM structure. Typical approaches for this model is to use either *User Custom Actions*, *JSLink*, *Content Editor Web Part* or *Script Editor Web Part*. Challenge of the DOM manipulation related model is dependency on the actual page structure. These kind of customizations are fragile and can easily break as new capabilities are released in SharePoint Online.
227+
215228
#### Related resources
216229

217230
##### Articles

docs/scenario-guidance/Business-processes.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1+
---
2+
title: Scenario Guidance - Business Processes
3+
description: Scenario guidance on business process options in SharePoint Online and in on-premises.
4+
ms.date: 03/26/2018
5+
---
6+
17
# Business Processes
28

39
## Summary
10+
411
Managing business processes related to items or documents stored in Microsoft SharePoint is a very common use case, which can be solved using various techniques. In this article you can find the available options for designing and running business processes in SharePoint Online and/or SharePoint 2013/2016 on-premises.
512

613
## High-level guideline/general rules
14+
715
Before going through the most common available options for managing business processes, let's see some useful high-level guidelines and general rules:
16+
817
* Whenever you need to run long-running business processes, rely on asynchronous processes that can be executed in background and independently from SharePoint
918
* Try to keep the processes as much simple as you can, using small building blocks eventually connected in a chain, rather than using huge processes that can be complex to maintain and difficult to debug
1019
* Try to use stateless processes as much as you can, to avoid allocating too many resources while running them and to define a more scalable solution, which can be hosted on multiple servers
@@ -19,13 +28,15 @@ Azure Logic Apps simplifies how you build automated scalable workflows that inte
1928
With Logic Apps you can build, schedule, and automate processes as workflows so you can integrate apps, data, systems, and services across enterprises or organizations. Logic Apps simplifies how you design and create scalable solutions for app integration, data integration, system integration, enterprise application integration (EAI), and business-to-business (B2B) communication, whether in the cloud, on premises, or both.
2029

2130
### Articles
31+
2232
* [Logic Apps](https://azure.microsoft.com/en-us/services/logic-apps/)
2333
* [Quickstart: Build your first logic app workflow - Azure portal](https://docs.microsoft.com/en-us/azure/logic-apps/quickstart-create-first-logic-app-workflow)
2434
* [Get started with the SharePoint Online connector](https://docs.microsoft.com/en-us/azure/connectors/connectors-create-api-sharepointonline)
2535
* [Get started with the SharePoint connector](https://docs.microsoft.com/en-us/azure/connectors/connectors-create-api-sharepointserver)
2636
* [Choose between Flow, Logic Apps, Functions, and WebJobs](https://docs.microsoft.com/en-us/azure/azure-functions/functions-compare-logic-apps-ms-flow-webjobs)
2737

2838
### Videos
39+
2940
* [Slice, dice, and route your SharePoint documents with Microsoft Flow, Azure Logic Apps, and Microsoft PowerApps](https://azure.microsoft.com/en-us/resources/videos/build-2017-slice-dice-and-route-your-sharepoint-documents-with-microsoft-flow-azure-logic-apps-and-microsoft-powerapps/)
3041
* [Microsoft Azure and Office 365 together: The modern business development platform](https://azure.microsoft.com/en-us/resources/videos/microsoft-ignite-2017-microsoft-azure-and-office-365-together-the-modern-business-development-platform/)
3142

@@ -34,29 +45,36 @@ With Logic Apps you can build, schedule, and automate processes as workflows so
3445
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2013 | SharePoint 2016_
3546

3647
Microsoft Flow is a service that helps you create automated workflows between your favorite apps and services to synchronize files, get notifications, collect data, and more. From within a Flow, you can connect to SharePoint Online or to an on-premises SharePoint 2013 or 2016 farm using the On-Premises Data Gateway to manage documents and list items. Moreover, Microsoft Flow is fully integrated with the modern lists and libraries of SharePoint Online.
48+
3749
As a developer, you can extend Microsoft Flow, enabling even more powerful solutions for organizations and customers.
3850

3951
### Articles
52+
4053
* [Get started with Microsoft Flow](https://docs.microsoft.com/en-us/flow/getting-started)
4154
* [Create a flow for a list or library in SharePoint Online or OneDrive for Business](https://support.office.com/en-us/article/create-a-flow-for-a-list-or-library-in-sharepoint-online-or-onedrive-for-business-a9c3e03b-0654-46af-a254-20252e580d01)
4255
* [Introducing Microsoft Flow integration for SharePoint Document Libraries](https://flow.microsoft.com/en-us/blog/flow-in-spo-document-libraries/)
4356
* [Choose between Flow, Logic Apps, Functions, and WebJobs](https://docs.microsoft.com/en-us/azure/azure-functions/functions-compare-logic-apps-ms-flow-webjobs)
4457

4558
### Videos
59+
4660
* [Slice, dice, and route your SharePoint documents with Microsoft Flow, Azure Logic Apps, and Microsoft PowerApps](https://azure.microsoft.com/en-us/resources/videos/build-2017-slice-dice-and-route-your-sharepoint-documents-with-microsoft-flow-azure-logic-apps-and-microsoft-powerapps/)
4761

4862
### Workflow Manager of SharePoint 2013/2016
4963

5064
_**Applies to:** SharePoint Online | SharePoint 2013 | SharePoint 2016_
5165

52-
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the Workflow Manager engine. In SharePoint Online you can only use declarative workflows, designed in SharePoint Designer 2013, or Workflow Add-Ins built using Microsoft Visual Studio and the SharePoint Add-In Model. In SharePoint 2013/2016 you can eventually create custom code-based workflows or custom actions. However, you should be careful using code-based workflows on-premises, because that could be a road blocker while migrating to SharePoint Online and Office 365.
66+
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the Workflow Manager engine. In SharePoint Online you can only use declarative workflows, designed in SharePoint Designer 2013, or Workflow Add-Ins built using Microsoft Visual Studio and the SharePoint Add-In Model.
67+
68+
In SharePoint 2013/2016 you can also create custom code-based workflows or custom actions. However, you should be careful using code-based workflows on-premises, as that could be a road blocker while potentially migrating to SharePoint Online and Office 365.
5369

5470
### Articles
71+
5572
* [Get started with workflows in SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/get-started-with-workflows-in-sharepoint)
5673
* [SharePoint workflow development best practices](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/sharepoint-workflow-development-best-practices)
5774
* [Workflow actions and activities reference for SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/workflow-actions-and-activities-reference-for-sharepoint)
5875

5976
### Samples
77+
6078
* [Create custom activities for workflow](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.Activities)
6179
* [Workflow.AssociateToHostWeb](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.AssociateToHostWeb)
6280
* [Call custom web services from a workflow](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.CallCustomService)
@@ -68,4 +86,4 @@ Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define
6886

6987
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2013 | SharePoint 2016_
7088

71-
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the legacy Windows Workflow Foundation 3.x engine. However, those are available just for backward compatibility, and you shouldn't create fresh new solutions based on this technology. Nevertheless, using Microsoft SharePoint Designer 2013, you can still create such kind of workflows.
89+
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the legacy Windows Workflow Foundation 3.x engine. This option is available just for backward compatibility, and should not be used for creating new solutions. Nevertheless, using Microsoft SharePoint Designer 2013, you can still create such kind of workflows.

docs/scenario-guidance/Custom-configurations.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: Custom configurations
3-
ms.date: 03/22/2018
2+
title: Scenario Guidance - Custom configurations
3+
description: Scenario guidance on where and how to store configuration values.
4+
ms.date: 03/26/2018
45
---
6+
57
# Custom configurations
68

79
## Summary
@@ -16,8 +18,6 @@ Allowing the different aspects of a SharePoint solution to be configurable makes
1618

1719
## Available options
1820

19-
### General recommendations
20-
2121
### Tenant properties
2222

2323
_**Applies to:** Office 365_
@@ -38,6 +38,16 @@ Tenant properties allow tenant administrators to add properties in the App Catal
3838

3939
_**Applies to:** Office 365 | SharePoint Server_
4040

41+
Description. Can't edit if no script enabled.
42+
43+
#### Related resources
44+
45+
##### Articles
46+
47+
##### Videos
48+
49+
##### Samples
50+
4151
### SharePoint Framework
4252

4353
_**Applies to:** Office 365 | SharePoint Server_
@@ -72,6 +82,27 @@ _**Applies to:** Office 365 | SharePoint Server_
7282

7383
_**Applies to:** Office 365 | SharePoint Server_
7484

85+
Description.
86+
87+
#### Related resources
88+
89+
##### Articles
90+
91+
##### Videos
92+
93+
##### Samples
94+
95+
7596
### Farm solutions
7697

77-
_**Applies to:** Office 365 | SharePoint Server_
98+
_**Applies to:** Office 365 | SharePoint Server_
99+
100+
Description. Can't edit if no script enabled.
101+
102+
#### Related resources
103+
104+
##### Articles
105+
106+
##### Videos
107+
108+
##### Samples

0 commit comments

Comments
 (0)