Skip to content

Commit

Permalink
build reference documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lahma committed Dec 10, 2023
1 parent 96eec69 commit 62661e3
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 41 deletions.
7 changes: 1 addition & 6 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

defaults:
run:
working-directory: website


# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
Expand All @@ -36,7 +31,7 @@ jobs:
uses: actions/configure-pages@v2

- name: Build
run: yarn install && yarn build
run: ./build.sh website

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
Expand Down
12 changes: 10 additions & 2 deletions .nuke/build.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,15 @@
"Compile",
"CompileExamples",
"CompileSolution",
"Docs",
"DocsReference",
"DocsSdk",
"Pack",
"PackBinaries",
"Publish",
"Restore",
"Test"
"Test",
"Website"
]
}
},
Expand All @@ -117,11 +121,15 @@
"Compile",
"CompileExamples",
"CompileSolution",
"Docs",
"DocsReference",
"DocsSdk",
"Pack",
"PackBinaries",
"Publish",
"Restore",
"Test"
"Test",
"Website"
]
}
},
Expand Down
50 changes: 50 additions & 0 deletions build-support/nuke-build/Build.Documentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
using Nuke.Common;
using Nuke.Common.IO;
using Nuke.Common.Tooling;

public partial class Build
{
readonly AbsolutePath ReferenceDocumentationPath = RootDirectory / "doc" / "reference";

Target Docs => _ => _
.DependsOn(DocsReference, DocsSdk)
.Executes(() =>
{
});

Target DocsReference => _ => _
.Executes(() =>
{
var targetDir = ReferenceDocumentationPath / "target";
targetDir.CreateOrCleanDirectory();

ProcessTasks.StartProcess(
workingDirectory: targetDir,
toolPath: "java",
arguments: """
-cp "../lib/saxon6-5-5/saxon.jar;../lib/xslthl-2.0.0/xslthl-2.0.0.jar" com.icl.saxon.StyleSheet ../src/index.xml "../lib/docbook-xsl-snapshot/html/springnet.xsl" highlight.xslthl.config="file:///${project.basedir}/lib/docbook-xsl-snapshot/highlighting/xslthl-config.xml"
"""
).AssertWaitForExit();

FileSystemTasks.CopyDirectoryRecursively(ReferenceDocumentationPath / "src" / "styles", targetDir / "html" / "styles", DirectoryExistsPolicy.Merge);
FileSystemTasks.CopyDirectoryRecursively(ReferenceDocumentationPath / "src" / "images", targetDir / "html" / "images", DirectoryExistsPolicy.Merge, excludeFile: file => file.Extension != ".gif" && file.Extension != ".svg" && file.Extension != ".jpg" && file.Extension != ".png");
FileSystemTasks.CopyDirectoryRecursively(ReferenceDocumentationPath / "lib" / "docbook-xsl-snapshot" / "images", targetDir / "html" / "images", DirectoryExistsPolicy.Merge);
});

Target DocsSdk => _ => _
.Executes(() =>
{
});

Target Website => _ => _
.DependsOn(DocsReference, DocsSdk)
.Executes(() =>
{
var webSiteDir = RootDirectory / "website";
ProcessTasks.StartProcess("yarn", arguments: "install", workingDirectory: webSiteDir).AssertWaitForExit();
ProcessTasks.StartProcess("yarn", arguments: "build", workingDirectory: webSiteDir).AssertWaitForExit();

// copy reference docs
FileSystemTasks.CopyDirectoryRecursively(ReferenceDocumentationPath / "target" / "html", webSiteDir / "public" / "doc-latest" / "reference" / "html", DirectoryExistsPolicy.Merge);
});
}
2 changes: 1 addition & 1 deletion website/src/pages/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Note: To view HTML Help files on Windows you may need to 'unblock' the file. You

### Latest Documentation

Reference ( [HTML](http://www.springframework.net/doc-latest/reference/html/index.html) / [PDF](http://www.springframework.net/doc-latest/reference/pdf/spring-net-reference.pdf) / [HTML Help](http://www.springframework.net/doc-latest/reference/htmlhelp/spring-net-reference.chm) )
Reference ( [HTML](/doc-latest/reference/html/index.html) / [PDF](/doc-latest/reference/pdf/spring-net-reference.pdf) / [HTML Help](/doc-latest/reference/htmlhelp/spring-net-reference.chm) )

### Release - 1.3.2

Expand Down
4 changes: 2 additions & 2 deletions website/src/pages/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can download them from [here](http://www.springsource.com/download/community
Nightly Snapshot Builds
Nightly snapshot builds are provided for testing and development purposes.

- Download the [nightly snapshot](http://www.springframework.net/downloads/nightly)
- Download the [nightly snapshot](/downloads/nightly)

## OLDER RELEASES

Expand Down Expand Up @@ -71,4 +71,4 @@ Nightly snapshot builds are provided for testing and development purposes.
**Spring.NET 1.1.2**

- Download it from [Sourceforge](https://sourceforge.net/project/showfiles.php?group_id=106751)
- See the [changelog](https://springframework.net/changelog.txt), [Breaking Changes](https://springframework.net/BreakingChanges-1.1.txt)
- See the [changelog](https://github.com/spring-projects/spring-net/blob/main/changelog.txt), [Breaking Changes](https://github.com/spring-projects/spring-net/blob/main/BreakingChanges.txt)
24 changes: 12 additions & 12 deletions website/src/pages/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,30 @@ keywords:

The examples directory in the distribution contain the following examples.

[Movie Finder](https://springframework.net/doc-latest/reference/html/quickstarts.html): A simple demonstration of Dependency Injection (DI) techniques using Spring's Inversion of Control (IoC) container.
[Movie Finder](/doc-latest/reference/html/quickstarts.html): A simple demonstration of Dependency Injection (DI) techniques using Spring's Inversion of Control (IoC) container.

[Application Context](https://springframework.net/doc-latest/reference/html/quickstarts.html): Demonstrates IoC container features such as localization, accessing of ResourceSet objects, and applying resources to object properties.
[Application Context](/doc-latest/reference/html/quickstarts.html): Demonstrates IoC container features such as localization, accessing of ResourceSet objects, and applying resources to object properties.

[Aspect Oriented Programming](https://springframework.net/doc-latest/reference/html/aop-quickstart.html): Demonstrates use of the AOP framework to add additional behavior to your existing object. Examples of programmatic and declarative AOP configuration are shown.
[Aspect Oriented Programming](/doc-latest/reference/html/aop-quickstart.html): Demonstrates use of the AOP framework to add additional behavior to your existing object. Examples of programmatic and declarative AOP configuration are shown.

[Distributed Computing](https://springframework.net/doc-latest/reference/html/remoting-quickstart.html): A calculator demonstrating remote service abstractions that let you 'export' a plain .NET object (PONO) via .NET Remoting, Web Services, or an EnterpriseService ServiceComponent. Corresponding client side proxies are also demonstrated.
[Distributed Computing](/doc-latest/reference/html/remoting-quickstart.html): A calculator demonstrating remote service abstractions that let you 'export' a plain .NET object (PONO) via .NET Remoting, Web Services, or an EnterpriseService ServiceComponent. Corresponding client side proxies are also demonstrated.

[WCF](http://www.springframework.net/doc-latest/reference/html/wcf-quickstart.html): A calculator demonstrating dependency injection and applying AOIP advice to WCF services.
[WCF](/doc-latest/reference/html/wcf-quickstart.html): A calculator demonstrating dependency injection and applying AOIP advice to WCF services.

[Web Application - Spring Air](http://www.springframework.net/doc-latest/reference/html/springair.html): A ticket booking application that demonstrates the ASP.NET framework showing features such as DI for ASP.NET pages, data binding, validation and localization.
[Web Application - Spring Air](/doc-latest/reference/html/springair.html): A ticket booking application that demonstrates the ASP.NET framework showing features such as DI for ASP.NET pages, data binding, validation and localization.

Web Development: Introductory examples showing use of dependency injection and Spring's bi-directional data binding in ASP.NET

[Data Access](https://springframework.net/doc-latest/reference/html/data-quickstart.html): Demonstrates the ADO.NET framework showing how to simplify the use of ADO.NET
[Data Access](/doc-latest/reference/html/data-quickstart.html): Demonstrates the ADO.NET framework showing how to simplify the use of ADO.NET

[Transaction Management](https://springframework.net/doc-latest/reference/html/tx-quickstart.html): Demonstrates the use of declarative transaction management for both local and distributed transaction in both .NET 1.1 and 2.0.
[Transaction Management](/doc-latest/reference/html/tx-quickstart.html): Demonstrates the use of declarative transaction management for both local and distributed transaction in both .NET 1.1 and 2.0.

AJAX : Demonstrates how to access a plain .NET object as a webservice in client side JavaScript

[NHibernate Northwind](http://www.springframework.net/doc-latest/reference/html/nh-quickstart.html): Demonstrates use of Spring's NHibernate integration to simplify the use of NHibernate. Web tier is also included showing how to use the Open-Session In View approach to session management in the web tier.
[NHibernate Northwind](/doc-latest/reference/html/nh-quickstart.html): Demonstrates use of Spring's NHibernate integration to simplify the use of NHibernate. Web tier is also included showing how to use the Open-Session In View approach to session management in the web tier.

[Apache ActiveMQ](http://www.springframework.net/doc-latest/reference/html/nms-quickstart.html): This quick start application demonstrates how to use asynchronous messaging to implement a system for purchasing a stock.
[Apache ActiveMQ](/doc-latest/reference/html/nms-quickstart.html): This quick start application demonstrates how to use asynchronous messaging to implement a system for purchasing a stock.

[Microsoft Message Queue](http://www.springframework.net/doc-latest/reference/html/msmq-quickstart.html): This quick start application demonstrates how to use asynchronous messaging to implement a system for purchasing a stock.
[Microsoft Message Queue](/doc-latest/reference/html/msmq-quickstart.html): This quick start application demonstrates how to use asynchronous messaging to implement a system for purchasing a stock.

[Job Scheduling](http://www.springframework.net/doc-latest/reference/html/quartz-quickstart.html): This quick start application demonstrates how to declarative create and configure Quartz Jobs, Triggers, and Schedules and how to make a PONO object be invoked by Quartz.
[Job Scheduling](/doc-latest/reference/html/quartz-quickstart.html): This quick start application demonstrates how to declarative create and configure Quartz Jobs, Triggers, and Schedules and how to make a PONO object be invoked by Quartz.
Loading

0 comments on commit 62661e3

Please sign in to comment.