Skip to content

Commit d4891d7

Browse files
rvdginstervdginste
committed
Docs: initial version of the documentation
1 parent ca79006 commit d4891d7

17 files changed

Lines changed: 267 additions & 0 deletions

‎docs/antora.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: ppwcode-server-core
2+
version: ~
3+
title: PPWCode.Server.Core
4+
nav:
5+
- modules/ROOT/nav.adoc

‎docs/modules/ROOT/examples/project.csproj‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<!-- ... -->
3+
4+
<ItemGroup>
5+
<!-- nuget package dependencies -->
6+
<PackageReference Include="PPWCode.Server.Core" Version="3.0.0" />
7+
</ItemGroup>
8+
9+
<!-- ... -->
10+
</Project>

‎docs/modules/ROOT/nav.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
* xref:index.adoc[]
3+
* xref:getting-started.adoc[]
4+
* xref:changelog.adoc[]

‎docs/modules/ROOT/pages/changelog.adoc‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
= Changelog
2+
3+
////
4+
The changelog is maintained here.
5+
6+
Note that it is best to update the changelog as new code is developed, and that
7+
the link to the GitHub tag is only added once we are ready to release.
8+
////
9+
10+
// some helper attributes for the release links
11+
:github: https://github.com/peopleware/net-ppwcode-server-core/releases/tag/
12+
:nuget: https://www.nuget.org/packages/PPWCode.Server.Core/
13+
:ppwcode-docs: https://peopleware.github.io/net-ppwcode-docs/ppwcode-server-core/
14+
15+
16+
:release: 3.0.0
17+
== `{release}`
18+
include::partial$changelog-release-section.adoc[]
19+
include::partial$changelog-{release}.adoc[]
20+
21+
:release: 2.0.0
22+
== `{release}`
23+
include::partial$changelog-release-section.adoc[]
24+
include::partial$changelog-{release}.adoc[]
25+
26+
:release: 1.4.0
27+
== `{release}`
28+
include::partial$changelog-release-section.adoc[]
29+
include::partial$changelog-{release}.adoc[]
30+
31+
:release: 1.3.0
32+
== `{release}`
33+
include::partial$changelog-release-section.adoc[]
34+
include::partial$changelog-{release}.adoc[]
35+
36+
:release: 1.2.0
37+
== `{release}`
38+
include::partial$changelog-release-section.adoc[]
39+
include::partial$changelog-{release}.adoc[]
40+
41+
:release: 1.1.1
42+
== `{release}`
43+
include::partial$changelog-release-section.adoc[]
44+
include::partial$changelog-{release}.adoc[]
45+
46+
:release: 1.1.0
47+
== `{release}`
48+
include::partial$changelog-release-section.adoc[]
49+
include::partial$changelog-{release}.adoc[]
50+
51+
:release: 1.0.2
52+
== `{release}`
53+
include::partial$changelog-release-section.adoc[]
54+
include::partial$changelog-{release}.adoc[]
55+
56+
:release: 1.0.1
57+
== `{release}`
58+
include::partial$changelog-release-section.adoc[]
59+
include::partial$changelog-{release}.adoc[]
60+
61+
:release: 1.0.0
62+
== `{release}`
63+
include::partial$changelog-release-section.adoc[]
64+
include::partial$changelog-{release}.adoc[]

‎docs/modules/ROOT/pages/getting-started.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
= Getting started
2+
3+
== Add NuGet package
4+
5+
This package is available on NuGet: https://www.nuget.org/packages/PPWCode.Server.Core[PPWCode.Server.Core].
6+
7+
You can use your IDE to add it as a dependency to your project, or manually add it in the `.csproj` file. You would typically add this project as a dependency to your `Server` project. This would look similar to the following:
8+
9+
[source,xml]
10+
----
11+
include::example$project.csproj[]
12+
----
13+
14+
After the package is added, you can use the base classes and interfaces from `PPWCode.Server.Core` in your code.

‎docs/modules/ROOT/pages/index.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= About
2+
3+
The project `PPWCode.Server.Core` is part of the .NET PPWCode project. It is meant to be used as the base for the `Server` project inside a .NET solution.
4+
5+
The project supports the most recent (supported) .NET SDKs.
6+
7+
8+
== Development
9+
10+
Development of the PPWCode is done on https://github.com/peopleware/net-ppwcode-server-core/tree/next[GitHub].
11+
12+
Releases (both stable and pre-release) are published on https://www.nuget.org/packages/PPWCode.Server.Core/[NuGet] by https://www.nuget.org/profiles/PeopleWare[PeopleWare].
13+
14+
15+
== License and Copyright
16+
17+
Copyright 2020–2026 by xref:ppwcode-net:ROOT:peopleware.adoc[PeopleWare].
18+
19+
Licensed under the Apache License, Version 2.0 (the "License");
20+
you may not use this file except in compliance with the License.
21+
You may obtain a copy of the License at
22+
23+
http://www.apache.org/licenses/LICENSE-2.0
24+
25+
Unless required by applicable law or agreed to in writing, software
26+
distributed under the License is distributed on an "AS IS" BASIS,
27+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28+
See the License for the specific language governing permissions and
29+
limitations under the License.

‎docs/modules/ROOT/partials/changelog-1.0.0.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
////
2+
The changelog for a specific release.
3+
Note that it is best to update the changelog as new code is developed.
4+
5+
All attributes used, must be included in this file to keep it self-contained.
6+
7+
This file is translated into markdown and used for the release notes in the GitHub release!
8+
////
9+
10+
=== Changes
11+
* Initial release
12+
* Supported target: `.NET Core App 3.1`

‎docs/modules/ROOT/partials/changelog-1.0.1.adoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
////
2+
The changelog for a specific release.
3+
Note that it is best to update the changelog as new code is developed.
4+
5+
All attributes used, must be included in this file to keep it self-contained.
6+
7+
This file is translated into markdown and used for the release notes in the GitHub release!
8+
////
9+
10+
=== Fixes
11+
* Fix initialization of links dictionary

‎docs/modules/ROOT/partials/changelog-1.0.2.adoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
////
2+
The changelog for a specific release.
3+
Note that it is best to update the changelog as new code is developed.
4+
5+
All attributes used, must be included in this file to keep it self-contained.
6+
7+
This file is translated into markdown and used for the release notes in the GitHub release!
8+
////
9+
10+
=== Fixes
11+
* Upgrade `System.Data.SqlClient`

‎docs/modules/ROOT/partials/changelog-1.1.0.adoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
////
2+
The changelog for a specific release.
3+
Note that it is best to update the changelog as new code is developed.
4+
5+
All attributes used, must be included in this file to keep it self-contained.
6+
7+
This file is translated into markdown and used for the release notes in the GitHub release!
8+
////
9+
10+
=== Changes
11+
* Upgraded dependencies

0 commit comments

Comments
 (0)