Details

    • Task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • None
    • sdk
    • DOC-2021-Aug29-S17, DOC-2021-Sep12-S18, DOC-2021-Sep26-S19, DOC-2021-Oct10-S20, DOC-2021-Oct24-S21, DOC-2021-Nov07-S22, DOC-2021-Nov21-S23
    • 1

    Description

      Add a page linked to Getting Started, which introduces the basics of VS Code & Visual Studio with the .NET SDK.

      Target audience: Java (and other) developers moved onto a C# project, and not knowing the ecosystem.

      Linked from Getting Started with something along the lines of
      New to the .NET scene? Details of setting up your environment for Couchbase here.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            Add brief explanation of `dotnet script` too, as we're using it for newer examples.

            hakim.cassimally Hakim Cassimally added a comment - Add brief explanation of `dotnet script` too, as we're using it for newer examples.

            This page already exists

            but both pages need updating.

            Looks like the former is taken from Jeff's intro above.

            • should go with latest .NET 5.0 (successor to .NET core 3.1) ?
              • (even if SDK itself targets 2.1, we shouldn't be suggesting devs install an unsupported development framework version)
              • update download links/instructions
              • update all our code samples
              • Note that "net5.0" is the correct TargetFramework name, but "netcoreapp5.0" is also understood, we should use the "official" name though.
            • Update installation instructions for Editor/IDE
              • I'm tempted to give VSCode instructions first ?
              • (As a non-C# person is much more likely to be comfortable with this. If you prefer Visual Studio you're probably not the target audience of this page?)
              • (To extent I'd ask do we need the VS IDE instructions?)
            • Go through examples (the devguide) and make sure:
              • instructions work (Michael Nitschinger's slides above looks useful)
              • code works
              • determine if these are best examples, or should use ones within docs project?
              • (At least explain how to run those)
                • Brief explanation of dotnet script
              • include:: a short, motivating snippet?
              • Link to travel-sample?
            hakim.cassimally Hakim Cassimally added a comment - This page already exists https://docs.couchbase.com/dotnet-sdk/current/hello-world/platform-help.html (linked from) https://docs.couchbase.com/dotnet-sdk/current/hello-world/start-using-sdk.html but both pages need updating. Looks like the former is taken from Jeff's intro above. should go with latest .NET 5.0 (successor to .NET core 3.1) ? (even if SDK itself targets 2.1, we shouldn't be suggesting devs install an unsupported development framework version) update download links/instructions update all our code samples Note that "net5.0" is the correct TargetFramework name, but "netcoreapp5.0" is also understood, we should use the "official" name though. Update installation instructions for Editor/IDE I'm tempted to give VSCode instructions first ? (As a non-C# person is much more likely to be comfortable with this. If you prefer Visual Studio you're probably not the target audience of this page?) (To extent I'd ask do we need the VS IDE instructions?) Go through examples (the devguide) and make sure: instructions work (Michael Nitschinger's slides above looks useful) code works determine if these are best examples, or should use ones within docs project? (At least explain how to run those) Brief explanation of dotnet script include:: a short, motivating snippet? Link to travel-sample?
            maria.shodunke Maria Shodunke (Inactive) added a comment - - edited

            Good points! 

            • Should go with latest .NET 5.0 (successor to .NET core 3.1) ?
              I think the .NET version needs to match what we support for sure so we should update that, best to check with .NET SDK team for this.
              What do our code examples use btw?

            - Update installation instructions for Editor/IDE
            In terms of IDE help, yeah I found it painful as a non-C# person to setup Visual Studio and generally try to ignore it  , so focusing on something that has less barrier to entry makes sense to me! VSCode first sounds good.

            - Go through examples (the devguide) and make sure...
            Think I'm confused about this point, do you mean add new examples in the platform help section? If that's the case we could grab something simple from any of our existing snippets I guess?
            Yep dotnet script explanation/setup would definitely be useful here.

            I guess we can link to travel-sample from the Getting Started page, as I guess Platform help should be mainly about getting your dev environment setup?

            maria.shodunke Maria Shodunke (Inactive) added a comment - - edited Good points!  Should go with latest .NET 5.0 (successor to .NET core 3.1) ? I think the .NET version needs to match what we support for sure so we should update that, best to check with .NET SDK team for this. What do our code examples use btw? - Update installation instructions for Editor/IDE In terms of IDE help, yeah I found it painful as a non-C# person to setup Visual Studio and generally try to ignore it  , so focusing on something that has less barrier to entry makes sense to me! VSCode first sounds good. - Go through examples (the devguide) and make sure... Think I'm confused about this point, do you mean add new examples in the platform help section? If that's the case we could grab something simple from any of our existing snippets I guess? Yep dotnet script explanation/setup would definitely be useful here. I guess we can link to travel-sample from the Getting Started page, as I guess Platform help should be mainly about getting your dev environment setup?

            Ah, I think the reference to devguide isn't that important, it's only mentioned on https://docs.couchbase.com/dotnet-sdk/current/hello-world/dotnet-environment.html which is another page to update/remove in favour of platform-help!

            Still, need instructions on how to run the examples.

            hakim.cassimally Hakim Cassimally added a comment - Ah, I think the reference to devguide isn't that important, it's only mentioned on https://docs.couchbase.com/dotnet-sdk/current/hello-world/dotnet-environment.html  which is another page to update/remove in favour of platform-help! Still, need instructions on how to run the examples.

            Agreed with Jeff, though we also need to mention 3.1 as it's LTS, and earlier versions as depends on dev shop.

            hakim.cassimally Hakim Cassimally added a comment - Agreed with Jeff, though we also need to mention 3.1 as it's LTS, and earlier versions as depends on dev shop.
            hakim.cassimally Hakim Cassimally added a comment - https://github.com/couchbase/docs-sdk-dotnet/pull/212  as first cut

            People

              hakim.cassimally Hakim Cassimally
              richard.smedley Richard Smedley
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty