Skip to content

Revert DocFX changes (#6738, #6756) #6759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -488,13 +488,14 @@ Target "DocFx" (fun _ ->
{ p with
ExcludeVersion = true
Version = "0.1.0-alpha-1611021200"
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"

let docsPath = FullName "./docs"
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx/")
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx.console/tools")

let args = StringBuilder()
|> append (docsPath @@ "docfx.json" )
|> append ("--warningsAsErrors")
|> toText

let result = ExecProcess(fun info ->
Expand Down
15 changes: 7 additions & 8 deletions build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $FakeVersion = "4.63.0"
$NugetVersion = "5.8.0";
$NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
$ProtobufVersion = "3.21.5"
$DocfxVersion = "2.67.0"
$DocfxVersion = "2.59.4"

$IncrementalistVersion = "0.8.0";

Expand Down Expand Up @@ -89,14 +89,13 @@ if (!(Test-Path $ProtobufExePath)) {
###########################################################################

# Make sure Docfx has been installed.
# Make sure the Incrementalist has been installed
if (Get-Command docfx -ErrorAction SilentlyContinue) {
Write-Host "Found docfx. Skipping install."
}
else{
$DocfxExePath = Join-Path $ToolPath "docfx"
$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe"
if (!(Test-Path $DocfxExePath)) {
Write-Host "Installing Docfx..."
dotnet tool install docfx --version $DocfxVersion --tool-path "$DocfxExePath"
Invoke-Expression "&`"$NugetPath`" install docfx.console -ExcludeVersion -Version $DocfxVersion -OutputDirectory `"$ToolPath`"" | Out-Null;
if ($LASTEXITCODE -ne 0) {
Throw "An error occured while restoring docfx.console from NuGet."
}
}

###########################################################################
Expand Down
9 changes: 3 additions & 6 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,9 @@
"fileMetadataFiles": [],
"template": [
"default",
"modern",
"template"
"template"
],
"postProcessors": ["ExtractSearchIndex"],
"noLangKeyword": false,
"warningsAsErrors": true,
"Docfx_Git_Timeout": 30000
"noLangKeyword": false
}
}
}
16 changes: 15 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,31 +60,41 @@ h2:before{
<div class="container">
<!-- FEATURED BOXES 3 -->
<div class="row featured-box-minimal">

<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-arrows-alt"></i> Simple Concurrency &amp; Distribution</h4>
<p>Asynchronous and Distributed by design. High-level abstractions like Actors and FSM.</p>
</div>

<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-flash"></i> High Performance</h4>
<p>50 million msg/sec on a single machine. Small memory footprint; ~2.5 million actors per GB of heap.</p>
</div>

<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-shield"></i> Resilient by Design</h4>
<p>Write systems that self-heal. Remote and/or local supervisor hierarchies.</p>
</div>


<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-th-large"></i> Elastic & Decentralized</h4>
<p>Adaptive load balancing, routing, partitioning and configuration-driven remoting.</p>
</div>

<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-plus-circle"></i> Extensible</h4>
<p>Use Akka.NET Extensions to adapt Akka to fit your needs.</p>
</div>

<div class="col-md-4 col-sm-6 col-xs-12">
<h4><i class="fa fa-exclamation"></i> Open Source </h4>
<p>Akka.NET is released under the Apache 2 license</p>
</div>

</div>
<!-- /FEATURED BOXES 3 -->

</div>
</section>
<!-- /WELCOME -->
Expand All @@ -93,6 +103,7 @@ h2:before{
<!-- PREMIUM -->
<section class="alternate">
<div class="container">

<div class="row">
<div class="col-md-6">
<h2><strong>Actor</strong> Model</h2>
Expand All @@ -101,7 +112,9 @@ The Actor Model provides a higher level of abstraction for writing concurrent an
<p>Actors were defined in the 1973 paper by <a href="http://en.wikipedia.org/wiki/Carl_Hewitt">Carl Hewitt</a> but have been popularized by the Erlang language, and used for example at Ericsson with great success to build highly concurrent and reliable telecom systems.</p>
<p><a href="/articles/intro/what-problems-does-actor-model-solve.html">Read more</a></p>
</div>

<div class="col-md-6 text-center">

<img class="img-responsive img-rounded appear-animation" data-animation="fadeIn" style="border:2px solid white;width:100%;border-radius:10px" src="/images/actor.png" alt="" />
</div>
</div>
Expand All @@ -115,6 +128,7 @@ Everything in Akka.NET is designed to work in a distributed setting: all interac
</p>
<p><a href="/articles/Remoting">Read more</a></p>
</div>

<div class="col-md-6 text-center">
<img class="img-responsive img-rounded appear-animation" data-animation="fadeIn" style="border:2px solid white;width:100%;border-radius:10px" src="/images/network.png" alt="" />
</div>
Expand All @@ -129,10 +143,10 @@ As a parent, the actor is responsible for handling its children’s failures (so
This enables a clean set of semantics for managing failures in a concurrent, distributed system and allows for writing highly fault-tolerant systems that self-heal.</p>
<p><a href="/articles/concepts/supervision.html">Read more</a></p>
</div>

<div class="col-md-6 text-center">
<img class="img-responsive img-rounded appear-animation" data-animation="fadeIn" style="border:2px solid white;width:100%;border-radius:10px" src="/images/supervision.png" alt="" />
</div>
</div>
</div>
</section>
<div style="height:90px;"></div>
6 changes: 6 additions & 0 deletions docs/template/styles/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,12 @@ ul li::marker{
}


footer{
position: relative !important;
opacity: 1 !important;
display: block !important;
}

.footer{
background: url(/images/footer.png) no-repeat left top, linear-gradient(270deg, #FFFFFF, #6DC9ED);

Expand Down
6 changes: 3 additions & 3 deletions serve-docs.ps1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docfx.ps1
$VisualStudioVersion = "17.5.0";
$DotnetSDKVersion = "7.0.203";
$VisualStudioVersion = "15.0";
$DotnetSDKVersion = "2.0.0";

# Get dotnet paths
$MSBuildExtensionsPath = "C:\Program Files\dotnet\sdk\" + $DotnetSDKVersion;
Expand All @@ -18,4 +18,4 @@ $env:MSBuildExtensionsPath = $MSBuildExtensionsPath;
$env:MSBuildSDKsPath = $MSBuildSDKsPath;

# Build our docs
& .\tools\docfx\docfx @args
& .\tools\docfx.console\tools\docfx @args
4 changes: 2 additions & 2 deletions src/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<PropertyGroup>
<Copyright>Copyright © 2013-2023 Akka.NET Team</Copyright>
<Authors>Akka.NET Team</Authors>
<VersionPrefix>1.5.7</VersionPrefix>
<VersionPrefix>1.5.4</VersionPrefix>
<PackageIcon>akkalogo.png</PackageIcon>
<PackageProjectUrl>https://github.com/akkadotnet/akka.net</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/akkadotnet/akka.net/blob/master/LICENSE</PackageLicenseUrl>
Expand Down Expand Up @@ -40,7 +40,7 @@
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>
<PropertyGroup>
<PackageReleaseNotes>Placeholder for nightlies*</PackageReleaseNotes>
<PackageReleaseNotes>placeholder for nightlies*</PackageReleaseNotes>
</PropertyGroup>
<!-- SourceLink support for all Akka.NET projects -->
<ItemGroup>
Expand Down