Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: avatica-go
    • Labels:
      None

      Description

      Create a web site for calcite-avatica-go.

      How about this:

      Should avatica-go appear on http://calcite.apache.org/avatica/downloads, or should it have its own download page? I think it probably the former.

        Issue Links

          Activity

          Hide
          francischuang Francis Chuang added a comment -

          I think this should be a low hanging fruit. I'll check out how this is done in the calcite and calcite-avatica repos and start working on a branch.

          Show
          francischuang Francis Chuang added a comment - I think this should be a low hanging fruit. I'll check out how this is done in the calcite and calcite-avatica repos and start working on a branch.
          Hide
          julianhyde Julian Hyde added a comment -

          The challenge is that we would like it to appear integrated with the Avatica web site, but (presumably) we want to keep the source files in Avatica-Go. So, maybe the simplest thing is few symbolic links in calcite-avatica/site to files under calcite-avatica-go/site. Then someone would re-generate the Avatica site from within an Avatica sandbox.

          Show
          julianhyde Julian Hyde added a comment - The challenge is that we would like it to appear integrated with the Avatica web site, but (presumably) we want to keep the source files in Avatica-Go. So, maybe the simplest thing is few symbolic links in calcite-avatica/site to files under calcite-avatica-go/site . Then someone would re-generate the Avatica site from within an Avatica sandbox.
          Hide
          francischuang Francis Chuang added a comment - - edited

          Julian HydeDoes it make sense if I just copy the file tree from calcite-avatica/site into calcite-avatica-go/site and replace the files inside _docs with my own markdown documents?

          Ok, that makes sense too. I am assuming I'd just need to write the markdown files and chuck them in my `site` folder then.

          Show
          francischuang Francis Chuang added a comment - - edited Julian Hyde Does it make sense if I just copy the file tree from calcite-avatica/site into calcite-avatica-go/site and replace the files inside _docs with my own markdown documents? Ok, that makes sense too. I am assuming I'd just need to write the markdown files and chuck them in my `site` folder then.
          Hide
          francischuang Francis Chuang added a comment -

          I've done the following:

          • Move documentation into go_client_reference.md under site/
          • Create go_history.md under site/
          • Reduced README.md to the barebones.

          See PR: https://github.com/apache/calcite-avatica-go/pull/2

          Question: I've removed most references to Apache Phoenix. Is this a good idea? There may be some benefits of including references to Phoenix as there is no doubt people are searching for a Go Phoenix database/sql driver using their favorite search engine. Having no references to Phoenix reduces this visibility, although it prevents confusion between the Phoenix and Calcite projects.

          Show
          francischuang Francis Chuang added a comment - I've done the following: Move documentation into go_client_reference.md under site/ Create go_history.md under site/ Reduced README.md to the barebones. See PR: https://github.com/apache/calcite-avatica-go/pull/2 Question: I've removed most references to Apache Phoenix. Is this a good idea? There may be some benefits of including references to Phoenix as there is no doubt people are searching for a Go Phoenix database/sql driver using their favorite search engine. Having no references to Phoenix reduces this visibility, although it prevents confusion between the Phoenix and Calcite projects.
          Hide
          julianhyde Julian Hyde added a comment -

          I think we should describe avatica-go as a general purpose client for avatica but also have a section about how it works for PQS right out of the box. This way we don't scare off people who are not using Phoenix. But we can make it clear in the Phoenix section that it works great for Phoenix, is tested on Phoenix versions x.x and y.y, and we have extensions such as the error message codes.

          Then I think Phoenix can also have a section on their site about the driver. James Taylor, What do you think?

          Show
          julianhyde Julian Hyde added a comment - I think we should describe avatica-go as a general purpose client for avatica but also have a section about how it works for PQS right out of the box. This way we don't scare off people who are not using Phoenix. But we can make it clear in the Phoenix section that it works great for Phoenix, is tested on Phoenix versions x.x and y.y, and we have extensions such as the error message codes. Then I think Phoenix can also have a section on their site about the driver. James Taylor , What do you think?
          Hide
          francischuang Francis Chuang added a comment -

          I've updated the web pages to include relevant information regarding Phoenix support.

          I also added a README under site/ stating that the files are symlinked by calcite-avatica and pushes should be done from that repository.

          Show
          francischuang Francis Chuang added a comment - I've updated the web pages to include relevant information regarding Phoenix support. I also added a README under site/ stating that the files are symlinked by calcite-avatica and pushes should be done from that repository.

            People

            • Assignee:
              francischuang Francis Chuang
              Reporter:
              julianhyde Julian Hyde
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Development