You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Pavel Tupitsyn (Jira)" <ji...@apache.org> on 2023/04/20 08:56:00 UTC
[jira] [Updated] (IGNITE-19328) .NET: Thin 3.0: Generate API documentation
[ https://issues.apache.org/jira/browse/IGNITE-19328?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Pavel Tupitsyn updated IGNITE-19328:
------------------------------------
Description:
Generate API documentation with [DocFX|https://dotnet.github.io/docfx/]
* Install it as a [local tool|https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools#install-a-local-tool]
* Update Gradle build to produce .NET docs along with Java docs on release
** Integrate docfx with msbuild somehow?
* Somehow include extended LINQ documentation https://github.com/apache/ignite-3/blob/main/modules/platforms/dotnet/Apache.Ignite/Internal/Linq/README.md
* Think of a way to integrate a Getting Started section
* Think of a way to integrate Examples
was:
Generate API documentation with [DocFX|https://dotnet.github.io/docfx/]
* Install it as a [local tool|https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools#install-a-local-tool]
* Update Gradle build to produce .NET docs along with Java docs on release
* Integrate docfx with msbuild somehow?
* Somehow include extended LINQ documentation https://github.com/apache/ignite-3/blob/main/modules/platforms/dotnet/Apache.Ignite/Internal/Linq/README.md
* Think of a way to integrate a Getting Started section
* Think of a way to integrate Examples
> .NET: Thin 3.0: Generate API documentation
> ------------------------------------------
>
> Key: IGNITE-19328
> URL: https://issues.apache.org/jira/browse/IGNITE-19328
> Project: Ignite
> Issue Type: Improvement
> Components: platforms, thin client
> Affects Versions: 3.0.0-beta1
> Reporter: Pavel Tupitsyn
> Assignee: Pavel Tupitsyn
> Priority: Major
> Labels: .NET, ignite-3
> Fix For: 3.0.0-beta2
>
>
> Generate API documentation with [DocFX|https://dotnet.github.io/docfx/]
> * Install it as a [local tool|https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools#install-a-local-tool]
> * Update Gradle build to produce .NET docs along with Java docs on release
> ** Integrate docfx with msbuild somehow?
> * Somehow include extended LINQ documentation https://github.com/apache/ignite-3/blob/main/modules/platforms/dotnet/Apache.Ignite/Internal/Linq/README.md
> * Think of a way to integrate a Getting Started section
> * Think of a way to integrate Examples
--
This message was sent by Atlassian Jira
(v8.20.10#820010)