Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-3486

.NET: Improve documentation

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: 1.6
    • Fix Version/s: 1.7
    • Component/s: platforms
    • Labels:

      Description

      Will document documentation related issues.

      Getting Started (https://apacheignite-net.readme.io/docs/getting-started-2)

      • document how to start with Apache.exe that is a part of release bundle.
      • By default Apache.Ignite.exe starts Ignite.NET node with the default configuration: config/default-config.xml.. However, this doesn't look valid statement. Tried to remove and corrupt it but the node was started all the time.
      • there is no installation instructions that are part of “platform\dotnet\README.txt”

      Configurations (https://apacheignite-net.readme.io/docs/configuration):

      • how to start with particular a particular configuration (app.config and XML). No examples, not clear.
      • more info about app.config: how it maps to C# classes, how to specify type names

      SQL QUERIES (https://apacheignite-net.readme.io/v1.5/docs/sql-queries):

      • cachetypemetadaa is used an example of configuration. QueryEntity's XML, App.config and source examples must be provided.
      • clarify keyType/keyTypeName confusion

      Troubleshooting (https://apacheignite-net.readme.io/docs/troubleshooting):

      Tuning:

      • Refer to Java readme tuning page and explain how to set JVM parameters from .NET (app.config and C#).

        Attachments

          Activity

            People

            • Assignee:
              dmagda Denis Magda
              Reporter:
              dmagda Denis Magda
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: