Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-8969

Windows installation refers to nonexistent binary list

    XMLWordPrintable

Details

    Description

      One of the first sentences is

      Windows binary packages can be found as downloads for each version listed below.

      But they are nowhere to be found. I don't think that this sentence is supposed to be there.

      Reporter: Jim Borden
      E-mail: jim.borden@couchbase.com

      Attachments

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

        Activity

          Thanks for the ticket Jim Borden
          This is caused by the content originally from https://docs.couchbase.com/c-sdk/current/project-docs/sdk-release-notes.html#platform-support-and-installation (and the next few sections)
          being spun off as https://github.com/couchbase/docs-sdk-c/blob/release/3.2/modules/hello-world/partials/installation.adoc
          to be used there and in the Getting Started page you linked (and also in the LCB cli page).
          There are a couple of other things that don't make sense to have in that page,
          so we need to see how we can rejig the whole thing.

          richard.smedley Richard Smedley added a comment - Thanks for the ticket Jim Borden This is caused by the content originally from  https://docs.couchbase.com/c-sdk/current/project-docs/sdk-release-notes.html#platform-support-and-installation  (and the next few sections) being spun off as  https://github.com/couchbase/docs-sdk-c/blob/release/3.2/modules/hello-world/partials/installation.adoc to be used there  and  in the Getting Started page you linked (and also in the LCB cli page). There are a couple of other things that don't make sense to have in that page, so we need to see how we can rejig the whole thing.
          hakim.cassimally Hakim Cassimally added a comment - - edited

          The other page that includes that is https://docs.couchbase.com/c-sdk/current/hello-world/cbc.html

          Problems:

          • "Windows binary packages can be found as downloads for each version listed below" only applies to the release notes page
            • even there, it's not entirely clear, as there isn't an obvious "list" (each version has a subheading and a lot of text before the list of binaries)
            • the text doesn't specify where below, so you have to scroll up and down to find it
            • (The "Verifying Installed Package" section is in between, and then there's a list of Jira tickets fixed in the release)
            • the "below" should probably link to #downloads at least as an example (e.g. to show the list of downloads for the most recent version)
            • The list of downloads doesn't repeat the phrase "Windows Binary" or anything about Windows...
            • (It mentions Visual Studio... which has a Mac version too, so this is ambiguous)
          • The sections on Linux are confusing: the heading "Configuring APT repositories (Debian, Ubuntu)" leads on to "For CentOS and Red Hat, the equivalent commands are:"
          • No binaries for Mac on the page.
            • Presumably only the latest version can be installed with Homebrew?
            • (There is wording about "To install development files and command line tools on Mac OS," but that doesn't mention "or versions other than the latest stable release")
          hakim.cassimally Hakim Cassimally added a comment - - edited The other page that includes that is https://docs.couchbase.com/c-sdk/current/hello-world/cbc.html Problems: "Windows binary packages can be found as downloads for each version listed below" only applies to the release notes page even there, it's not entirely clear, as there isn't an obvious "list" (each version has a subheading and a lot of text before the list of binaries) the text doesn't specify where below, so you have to scroll up and down to find it (The "Verifying Installed Package" section is in between, and then there's a list of Jira tickets fixed in the release) the "below" should probably link to #downloads at least as an example (e.g. to show the list of downloads for the most recent version) The list of downloads doesn't repeat the phrase "Windows Binary" or anything about Windows... (It mentions Visual Studio... which has a Mac version too, so this is ambiguous) The sections on Linux are confusing: the heading "Configuring APT repositories (Debian, Ubuntu)" leads on to "For CentOS and Red Hat, the equivalent commands are:" No binaries for Mac on the page. Presumably only the latest version can be installed with Homebrew? (There is wording about "To install development files and command line tools on Mac OS," but that doesn't mention "or versions other than the latest stable release")

          I don't understand the wording:

          This section assumes you know how to add an external http://yum.baseurl.org/[yum] repository and Linux quick start explains the steps it will perform on your distribution.

          (and ditto for Debian). Asked for clarification.

          hakim.cassimally Hakim Cassimally added a comment - I don't understand the wording: This section assumes you know how to add an external http://yum.baseurl.org/[yum ] repository and Linux quick start explains the steps it will perform on your distribution. (and ditto for Debian). Asked for clarification.
          hakim.cassimally Hakim Cassimally added a comment - https://github.com/couchbase/docs-sdk-c/pull/121

          merged

          hakim.cassimally Hakim Cassimally added a comment - merged

          People

            hakim.cassimally Hakim Cassimally
            borrrden borrrden
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty