Skip to content

Commit 890ee51

Browse files
committed
Fix docs
1 parent a448629 commit 890ee51

File tree

10 files changed

+28
-27
lines changed

10 files changed

+28
-27
lines changed

.github/workflows/docs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches:
66
- 'main'
7-
- 'mkdocs' # To remove after merge
7+
- 'mkdocs' # Remove after merge
88
- 'v*'
99
tags:
1010
- 'v*'
@@ -59,7 +59,8 @@ jobs:
5959
pages_threshold: major_outage
6060
-
6161
name: Deploy
62-
if: success() && github.event_name != 'pull_request' && (endsWith(github.ref, github.event.repository.default_branch) || steps.prepare.outputs.release == 'true')
62+
#if: success() && github.event_name != 'pull_request' && (endsWith(github.ref, github.event.repository.default_branch) || steps.prepare.outputs.release == 'true')
63+
if: success() && github.event_name != 'pull_request' # Remove after merge and use the previous condition
6364
uses: crazy-max/[email protected]
6465
with:
6566
target_branch: gh-pages

docs/Migration/Custom-Controls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
>> Content to come!
1+
_TODO_

docs/Migration/MasterPages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
>> Content to come!
1+
_TODO_

docs/Migration/NET-Standard.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# .NET Standard to the Rescue
2-
31
.NET Standard is the definition of a contract, a series of APIs, that all .NET frameworks must implement to be considered a .NET framework. .NET Framework, .NET Core, Xamarin, and Mono all implement various .NET Standard versions (or specifications) and this now becomes a vehicle for you to build your class libraries to be re-usable across various version of .NET.
42

53
>> Needs links to the .NET Standard specifications and repository on GitHub
@@ -19,8 +17,16 @@ For your existing Web Forms applications, unless you are executing unsafe code o
1917

2018
## Sample 1: Update an existing class library
2119

22-
The first sample demonstrates updating a simple class library to .NET Standard. In this model, we're assuming that you already have your business logic code properly separated from your user-interface and managed inside a class-library project that targets .NET Framework 4.5. You can find the source and directions for this sample in the [samples/netstandard-1](samples/netstandard-1) folder.
20+
The first sample demonstrates updating a simple class library to .NET Standard. In this model, we're assuming that you already have your business logic code properly separated from your user-interface and managed inside a class-library project that targets .NET Framework 4.5.
21+
22+
### Sample
23+
24+
This is a simple migration sample, demonstrating migrating a class-library from .NET Framework 4.5 to .NET Standard 2.0
2325

2426
## Sample 2: Refactoring Business Logic
2527

26-
The second sample shows how to take an existing ASP<span></span>.NET application and refactor our some business logic as a .NET Standard project. You can find the source and directions for this sample in the [samples/netstandard-2](samples/netstandard-2) folder.
28+
The second sample shows how to take an existing ASP<span></span>.NET application and refactor our some business logic as a .NET Standard project.
29+
30+
### Sample
31+
32+
This sample shows how to refactor some business logic from our Web Forms application into a .NET Standard library that can eventually be re-used in the .NET Core / ASP<span></span>.NET Core / Server-side Blazor application.

docs/Migration/Strategies.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Migration Strategies
2-
31
Migration from ASP<span></span>.NET Web Forms to Blazor is not simple and this repository attempts to make it easier for developers to reuse as much of their Web Forms application as possible. The two technologies are 'concept compatible', but run on different implementations of the .NET runtime (.NET Framework vs. .NET Core / .NET 5+)
42

53
We, the maintainers of this project, believe that with a little ingenuity the markup from a Web Forms application can be copied over with minimal changes and function similarly to its original purpose. We believe that well formatted and maintained code in Web Forms should be easily migrated. Applications that are a significant mix of C# and markup will have a more difficult time going through this process.
64

75
## Readiness Planning
86

9-
Migrating an application to Blazor is not a trivial process and it would be great to have some indication ahead of time how much work is needed and what steps you need to take to prepare to migrate. Check our migration [readiness document](../migration_readiness.md) to help determine how much work will be needed for your application to begin the process.
7+
Migrating an application to Blazor is not a trivial process and it would be great to have some indication ahead of time how much work is needed and what steps you need to take to prepare to migrate. Check our migration [readiness document](migration_readiness.md) to help determine how much work will be needed for your application to begin the process.
108

119
## Known Required Changes
1210

@@ -34,7 +32,7 @@ The concept of a MasterPage does not exist in Blazor. Instead, your ASPX pages
3432

3533
### Page Directive Changes
3634

37-
### No <%#: DataBinding expressions
35+
### No <%#: DataBinding expressions
3836

3937
Databinding expressions in Web Forms let you evaluate the content of the elements and format them appropriately for presentation. For editor controls, it also allows you to setup a 2-way binding so that you can receive values entered into the same variable bound to the control.
4038

@@ -50,25 +48,25 @@ For editor components, simply `@bind` the variable to the component. This will
5048
<input type="text" name="foo" @bind="bar" />
5149
```
5250

53-
### No Namespaces, No Tag-Prefixes
51+
### No Namespaces, No Tag-Prefixes
5452

5553
Namespaces and tag-prefixes are gone. You can do a Find and Replace on `asp:` and remove those from your markup.
5654

5755
### Redirect Color to WebColor
5856

59-
This change should **NOT** require any coding modifications. In Web Forms, you could refer to `System.Drawing.Color` objects when setting `BackColor`, `BorderColor`, and `ForeColor` to name a few properties. You could _ALSO_ freely use HTML hex-color notation freely in these fields.
57+
This change should **NOT** require any coding modifications. In Web Forms, you could refer to `System.Drawing.Color` objects when setting `BackColor`, `BorderColor`, and `ForeColor` to name a few properties. You could _ALSO_ freely use HTML hex-color notation freely in these fields.
6058
The `System.Drawing.Color` object does not have a converter that allows you to convert between these two formats, so we wrapped the object and made `BlazorWebFormsComponents.WebColor` that performs the same task and allows the interchange of `System.Drawing.Color` object with HTML hex notation.
6159

6260
## Strategies
6361

6462
- A simple initial site migration
6563
- Intertwined code
66-
- [DataBinder](Databinder.md)
64+
- [DataBinder](../UtilityFeatures/Databinder.md)
6765
- Model-Binding
6866
- [.NET Standard to the rescue!](NET-Standard.md)
6967
- Other considerations
7068
- [MasterPage](MasterPages.md)
7169
- Rearchitecting Web Application Layout
7270
- UserControls
7371
- The simple conversion
74-
- [Custom Controls](Custom-Controls.md)
72+
- [Custom Controls](Custom-Controls.md)

docs/Migration/User-Controls.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
# User Controls
2-
3-
>> Content to come
1+
_TODO_

docs/Migration/migration_readiness.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Web Forms Application Migration Readiness
2-
31
This document is intended as a primer for prospective teams to review in preparation for migrating their Web Forms applications to Server-Side Blazor. We believe the migration is a multi-step process and this application review and preparation is the first step in migrating / rewriting an application using Blazor.
42

53
## Definitions

docs/Migration/samples/netstandard-1/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/Migration/samples/netstandard-2/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,9 @@ nav:
9090
- ViewState: UtilityFeatures/ViewState.md
9191
- Migration:
9292
- Getting started: Migration/readme.md
93+
- Migration Strategies: Migration/Strategies.md
94+
- Custom Controls: Migration/Custom-Controls.md
95+
- Master Pages: Migration/MasterPages.md
96+
- .NET Standard to the Rescue: Migration/NET-Standard.md
97+
- User Controls: Migration/User-Controls.md
98+
- Web Forms Application Migration Readiness: Migration/migration_readiness.md

0 commit comments

Comments
 (0)