Skip to content

Commit 92e356d

Browse files
committed
chore: Update documentation for .NET 9.0 release, including Docker commands and SDK references
1 parent bcb24d2 commit 92e356d

File tree

15 files changed

+77
-54
lines changed

15 files changed

+77
-54
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ docker run -d -p 1313:80 genocs/genocs-library-docs
3838
5. push the image to docker hub
3939
```bash
4040
docker login
41+
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:1.0.0
4142
docker tag genocs/genocs-library-docs genocs/genocs-library-docs:latest
43+
44+
docker push genocs/genocs-library-docs:1.0.0
4245
docker push genocs/genocs-library-docs:latest
4346
```
4447

config/_default/params.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ copyRight = "Copyright (c) 2024 Genocs"
6969
# Alert
7070
alert = true
7171
alertDismissable = false
72-
alertText = ".NET8 Genocs Library Released <a target=\"_blank\" class=\"alert-link\" href=\"https://www.youtube.com/watch?v=TgxDvU---Ak/\">Click here to get started!</a>"
72+
alertText = ".NET 9.0 Genocs Library Released <a target=\"_blank\" class=\"alert-link\" href=\"https://www.youtube.com/watch?v=TgxDvU---Ak/\">Click here to get started!</a>"
7373

7474
# Edit Page
7575
repoHost = "GitHub"

content/en/blazor-template/general/development-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Development Environment"
33
description: "Setting up the Development Environment for the Blazor WebAssembly Template"
44
lead: "Let's get started with setting up the Development Environment for Blazor WebAssembly Template Development!"
55
date: 2023-05-13T15:40:19+02:00
6-
lastmod: 2024-02-29T19:44:00+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -18,11 +18,11 @@ Genocs Library's **Blazor WebAssembly Template** Project Development needs you t
1818

1919
## .NET SDK
2020

21-
As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 8.0.
21+
As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 9.0.
2222

2323
Ensure that you have the latest version of the SDK available - [Download from Microsoft](https://dotnet.microsoft.com/download/dotnet/8.0)
2424

25-
{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 8.0.201" />}}
25+
{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 9.0.101" />}}
2626

2727

2828
## IDE

content/en/blazor-template/general/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Overview"
3-
description: "Built with .NET 8 and MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
4-
lead: "Built with .NET 8 and MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
3+
description: "Built with .NET 9 and MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
4+
lead: "Built with .NET 9 and MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
55
date: 2023-05-13T15:40:19+02:00
6-
lastmod: 2024-02-29T19:44:19+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -21,12 +21,12 @@ toc: true
2121
The goal of this repository is to help developers / companies kickstart their Web Application Development with a pre-built Blazor WebAssembly Template that includes several much needed components and features.
2222

2323
> Note that this is a frontend / client application only! The backend for this application is available in a separate repository.
24-
> - Find Genocs Library's .NET 8 Web API Template here - https://github.com/Genocs/templates
24+
> - Find Genocs Library's .NET 9.0 Web API Template here - https://github.com/Genocs/templates
2525
2626
## Prerequisites
2727

2828
- Make sure you have the API Running. Here is Genocs API Backend - https://github.com/Genocs/templates
29-
- Once Genocs Library's .NET 8 Web API is up and running, run the Blazor WebAssembly Project to consume it's services.
29+
- Once Genocs Library's .NET 9.0 Web API is up and running, run the Blazor WebAssembly Project to consume it's services.
3030

3131
## Community
3232

content/en/introduction/getting-started/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Getting Started"
33
description: "Let's get started with Genocs Library!"
44
lead: "Let's get started with Genocs Library!"
55
date: 2023-05-13T15:40:19+02:00
6-
lastmod: 2024-11-16T00:00:00+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -39,7 +39,7 @@ As the name suggests, the idea is to provide a full-stack end to end solution to
3939

4040
<b>Genocs Library</b> should be the one-stop that caters to the needs of various developers in various technology. This obviously would require a lot of community adaptation and contributions.
4141

42-
As for the initial releases, <b>Genocs Library</b> sports an API Project built on Microsoft's newest .NET 8 and the front-end application (that consumes the .NET 8 Web API) built with Blazor WebAssembly!
42+
As for the initial releases, <b>Genocs Library</b> sports an API Project built on Microsoft's newest .NET 9.0 and the front-end application (that consumes the .NET 9 Web API) built with Blazor WebAssembly!
4343

4444
## Projects
4545

@@ -49,7 +49,7 @@ As for the initial releases, <b>Genocs Library</b> sports an API Project built o
4949
<div class="row justify-content-center text-center" style="padding:10px!important">
5050
<div class="card feature-card" style="padding:0px!important">
5151
<div style="padding:20px">
52-
<h2 class="h4">.NET 8 Microservice Template</h2>
52+
<h2 class="h4">.NET 9.0 Microservice Template</h2>
5353
<div class="tablet-group">
5454
<div class="tablet">web api</div>
5555
<div class="tablet tablet-secondary">.NET</div>
@@ -61,13 +61,13 @@ As for the initial releases, <b>Genocs Library</b> sports an API Project built o
6161
</div>
6262
<div class="card feature-card" style="padding:0px!important">
6363
<div style="padding:20px">
64-
<h2 class="h4">.NET 8 Web API Template</h2>
64+
<h2 class="h4">.NET 9.0 Web API Template</h2>
6565
<div class="tablet-group">
6666
<div class="tablet">web api</div>
6767
<div class="tablet tablet-secondary">.NET</div>
6868
<div class="tablet">multitenancy</div>
6969
</div>
70-
<p>Getting to work with the latest and greatest of Microsoft's .NET 8 Web API fused with the goodness of Genocs Library.</p>
70+
<p>Getting to work with the latest and greatest of Microsoft's .NET 9.0 Web API fused with the goodness of Genocs Library.</p>
7171
<p><a href="https://github.com/Genocs/templates">View Github Repository</a> | <a href="https://genocs-blog.netlify.app/templates/general/getting-started/">Read Getting Started Guide</a></p>
7272
</div>
7373
</div>
@@ -80,7 +80,7 @@ As for the initial releases, <b>Genocs Library</b> sports an API Project built o
8080
<div class="tablet tablet-secondary">blazor webassembly</div>
8181
<div class="tablet">multitenancy</div>
8282
</div>
83-
<p>Clean Architecture Template Template for .NET 8.0 Blazor WebAssembly built for Genocs-Api WebAPI with MudBlazor Components.</p>
83+
<p>Clean Architecture Template Template for .NET 9.0 Blazor WebAssembly built for Genocs-Api WebAPI with MudBlazor Components.</p>
8484
<p><a href="https://github.com/Genocs/genocs-library-docs">View Github Repository</a> | <a href="https://genocs-blog.netlify.app/blazor-template/general/overview/">Read Getting Started Guide</a></p>
8585
</div>
8686
</div>

content/en/library/builder/index.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@ services.AddGenocs(builder.Configuration);
4343
```
4444

4545

46+
> NOTE: By Adding `AddGenocs(builder.Configuration)` you are adding the following services:
47+
48+
// Add health checks
49+
services.AddHealthChecks();
50+
51+
No need to call MapHealthChecks, it is already done for you.
52+
53+
54+
```csharp
55+
// Map the Default Endpoints
56+
// It contains the following endpoints:
57+
// - /
58+
// - /health
59+
// - /live
60+
app.MapDefaultEndpoints();
61+
```
62+
63+
64+
4665
## Example
4766

4867
This is an example of how to setup the builder in the `Program.cs` file along with some other services.
@@ -90,9 +109,6 @@ services.AddControllers().AddJsonOptions(x =>
90109
x.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
91110
});
92111

93-
// Add health checks
94-
services.AddHealthChecks();
95-
96112

97113
var settings = new SecretSettings();
98114
builder.Configuration.GetSection(SecretSettings.Position).Bind(settings);
@@ -137,8 +153,7 @@ app.UseAuthorization();
137153

138154
app.MapControllers();
139155

140-
// Map the health checks
141-
app.MapHealthChecks("/hc");
156+
app.MapDefaultEndpoints();
142157

143158
// Run the application
144159
app.Run();
@@ -154,13 +169,18 @@ Log.CloseAndFlush();
154169

155170
## Options
156171

157-
- `name` - The service name.
158-
- `service` - Service name used TBW.
159-
- `instance` - The service instance.
160-
- `version` - The service version.
172+
- `name` - The service name. The service name is used to display the banner and the version is used to display the version of the service.
173+
- `service` - Service property is used to identify the service. This is used to identify the service in the logs. It *mandatory* to have this property when using the **OpenTelemetry** support.
174+
- `instance` - The service instance. If present then the instance is used to setup **OpenTelemetry**.
175+
- `version` - The service version. If present then the version is used to setup **OpenTelemetry**.
161176
- `displayBanner` - If true then the banner is shown into the console.
162177
- `displayVersion` - If true then the service version is shown into the console. See `version` param.
163178

179+
180+
The service name is used to display the banner and the version is used to display the version of the service.
181+
182+
```csharp
183+
164184
## Settings
165185

166186
Use the following settings in the `appsettings.json` file according to your needs.

content/en/templates/general/development-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Development Environment"
33
description: "Setting up the Development Environment for the Genocs .NET Templates"
44
lead: "Let's get started with setting up the Development Environment"
55
date: 2023-05-13T15:51:03+02:00
6-
lastmod: 2024-08-21 14:50:50+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -20,11 +20,11 @@ Please Note that this project is being built on a Windows11 Machine using Visual
2020

2121
## .NET SDK
2222

23-
As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 8.0.
23+
As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 9.0.
2424

2525
Ensure that you have the latest version of the SDK available - [Download from Microsoft](https://dotnet.microsoft.com/download/dotnet/8.0)
2626

27-
{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 8.0.201" />}}
27+
{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 9.0.101" />}}
2828

2929

3030
## IDE

content/en/templates/general/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To get started with this Template, here are the available options.
3535

3636
Before creating your first Genocs Library solution, you should ensure that your local machine has:
3737

38-
- **.NET 8** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
38+
- **.NET 9.0** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/9.0).
3939
- **NodeJS (16+)** You can find the download [here](https://nodejs.org/en/download).
4040

4141
### Installation

content/en/templates/general/makefile-commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "MakeFile Commands"
33
description: "Here are some important MakeFile Commands that are to be used along with Genocs Library CLI."
44
lead: "Here are some important MakeFile Commands that are to be used along with Genocs Library CLI."
55
date: 2023-05-13 10:23:13+02:00
6-
lastmod: 2024-08-21 14:50:50+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -44,7 +44,7 @@ This packs your Solution into a nuget package. The required .template.config fol
4444
``` bash
4545
make publish
4646
```
47-
Using .NET 8's Built-In Containerization feature, this command builds the docker image for you using the `dotnet publish` command internally. Here is how to setup the metadata of your docker image.
47+
Using .NET 9.0's Built-In Containerization feature, this command builds the docker image for you using the `dotnet publish` command internally. Here is how to setup the metadata of your docker image.
4848

4949
Navigate to src/Host/Host.csproj file and modify the following as per your requirement.
5050

content/en/templates/general/overview.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Overview"
3-
description: "Genocs Library built with .NET8. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
4-
lead: "Genocs Library built with .NET8. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
3+
description: "Genocs Library built with .NET 9.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
4+
lead: "Genocs Library built with .NET 9.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles."
55
date: 2023-05-13 09:17:27+02:00
6-
lastmod: 2024-08-21 14:50:50+02:00
6+
lastmod: 2024-11-24T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -22,11 +22,11 @@ Genocs Library is a starting point for your next `.NET Microservices library` th
2222
2323
## Goals
2424

25-
The goal of this repository is to provide a complete and feature-rich starting point for any .NET Developer / Team to kick-start their next major project using .NET 8 microservice cloud agnostic solution. This also serves the purpose of learning advanced concepts and implementations such as `Multitenancy, CQRS, Onion Architecture, Clean Coding standards, Cloud Deployments with Terraform to AWS, Docker Concepts, CICD Pipelines & Workflows` and so on.
25+
The goal of this repository is to provide a complete and feature-rich starting point for any .NET Developer / Team to kick-start their next major project using .NET 9.0 microservice cloud agnostic solution. This also serves the purpose of learning advanced concepts and implementations such as `Multitenancy, CQRS, Onion Architecture, Clean Coding standards, Cloud Deployments with Terraform to AWS, Docker Concepts, CICD Pipelines & Workflows` and so on.
2626

2727
## Features
2828

29-
- [x] Built on .NET8
29+
- [x] Built on .NET 9.0
3030
- [x] Follows Clean Architecture Principles
3131
- [x] Domain Driven Design
3232
- [x] Cloud Ready. Can be deployed to AWS Infrastructure as ECS Containers using Terraform!
@@ -84,7 +84,7 @@ To get started with this Template, here are the available options.
8484

8585
Before creating your first solution, you should ensure that your local machine has:
8686

87-
- **.NET 8** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
87+
- **.NET 9.0** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/9.0).
8888
- **NodeJS (16+)** You can find the download [here](https://nodejs.org/en/download).
8989

9090
#### Installation
@@ -115,7 +115,7 @@ OR
115115
genocs api n Genocs.Starter
116116
```
117117

118-
This will create a new .NET 8 WebAPI solution for you using the Genocs Templates.
118+
This will create a new .NET 9.0 WebAPI solution for you using the Genocs Templates.
119119
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/templates/general/getting-started/)
120120

121121
#### Update
@@ -206,7 +206,7 @@ For further steps and details, [Read the Getting Started Guide](https://genocs-b
206206

207207
## Containerization
208208

209-
The API project, being .NET 8, it is configured to have built-in support for containerization. That means, you really don't need a Dockerfile to containerize the webapi.
209+
The API project, being .NET 9.0, it is configured to have built-in support for containerization. That means, you really don't need a Dockerfile to containerize the webapi.
210210

211211
To build a docker image, all you have to do is, ensure that docker-desktop or docker instance is running. And run the following command at the root of the solution.
212212

0 commit comments

Comments
 (0)