docs(clients): add onboarding for new `influxdb3-go`, `influxdb3-csharp`, `influxdb3-java` #6690

Sciator · 2023-05-16T12:46:16Z

Changed golang wizard to use new https://github.com/bonitoo-io/influxdb3-go for ioxOnboarding
Added java wizard + use new https://github.com/bonitoo-io/influxdb3-java for ioxOnboarding
Added c# wizard + use new https://github.com/bonitoo-io/influxdb3-csharp for ioxOnboarding

GO

CSharp

Java

Checklist

Authors and Reviewer(s), please verify the following:

A PR description, regardless of the triviality of this change, that communicates the value of this PR
Well-formatted conventional commit messages that provide context into the change
Documentation updated or issue created (provide link to issue/PR)
Signed CLA (if not already signed)
Feature flagged, if applicable

mavarius

Overall, I'm glad these libraries are a thing now. However, this PR needs some changes.

These new client libraries are for Serverless, not TSM. The home pages and guides differ (TSM has Flux guides, and Serverless has SQL guides). The TSM home page should not be modified in this PR.

TSM Home page

Serverless Homepage

The "Application Code" sections of "Add Data" and "Query Data" need updating on the home page to have the appropriate language options open the new guides.

The Add Data section dropdown should still contain all the languages, however, when Go, C#, or Java are selected the new guides should be presented.

The Query Data section dropdown should only show C#, Go, Java, and Python (the ones with SQL guides).

The Client Libraries section of the Load Data page should have the C# and Java cards updated to include the "write | query" tag. These cards should also link to the new guides.
We're trying not to use the term IOx going forward so more appropriate terminology should be used. "Serverless" when talking about the service, and other appropriate terms such as "InfluxDBClient", "Write" or "Query" when naming things in the example code.

mavarius · 2023-06-09T17:58:06Z

src/homepageExperience/containers/HomepageContentsTSM.tsx

This is the wrong file. The file that should be edited is HomepageContents.tsx since this is for Serverless accounts, not TSM accounts.

mavarius · 2023-06-12T21:47:14Z

src/homepageExperience/components/steps/csharp/ExecuteQuerySql.tsx

+        results of what we have written.
+      </p>
+      <p>
+        Add the following code to the <code>IOxExample</code> class:


Can we call this class something more specific to what they're doing than "IOxExample"?

Renamed to WriteQueryExample.

mavarius · 2023-06-12T21:53:12Z

src/homepageExperience/components/steps/csharp/InitializeClient.tsx

+
+namespace InfluxDB3.Examples.IOx;
+
+public class IOxExample


Rename this class to be something more meaningful to the end-user.

Renamed to WriteQueryExample.

mavarius · 2023-06-12T21:53:51Z

src/homepageExperience/components/steps/csharp/InitializeClient.tsx

+using InfluxDB3.Client;
+using InfluxDB3.Client.Write;
+
+namespace InfluxDB3.Examples.IOx;


Avoid the term IOx if possible.

Renamed to InfluxDB3.Examples

mavarius · 2023-06-12T21:57:21Z

src/homepageExperience/components/steps/csharp/InstallDependenciesSql.tsx

+          onCopy={this.logCopyCodeSnippet}
+          text="dotnet add package InfluxDB3.Client"
+        />
+      </>


Are there any other things that the user needs to have installed to make this work properly? Are there version requirements that must be met to avoid errors? If so, please add them here. See the Go and Python guides for examples of this.

No. The dotnet add package InfluxDB3.Client install latest stable version of the client with all required dependencies.

mavarius · 2023-06-13T03:02:14Z

src/homepageExperience/components/steps/java/InstallDependenciesSql.tsx

+          onCopy={this.logCopyCodeSnippet}
+          text={gradleDependency}
+        />
+      </>


Add links to other dependencies or specify minimum versions of things needed to get this running (including Maven & Gradle). (See Python and Go examples)

mavarius · 2023-06-13T03:03:33Z

src/homepageExperience/components/steps/java/WriteDataSql.tsx

+import {getBuckets} from 'src/buckets/actions/thunks'
+import {event} from 'src/cloud/utils/reporting'
+
+const logCopyCodeSnippet = () => {


Scope these functions within the component.

mavarius · 2023-06-13T03:14:51Z

src/homepageExperience/containers/CSharpWizard.tsx

+          />
+        )
+      }
+      case 8: {


There is no case 8, this is redundant.

mavarius · 2023-06-13T03:18:59Z

src/homepageExperience/containers/JavaWizard.tsx

+          />
+        )
+      }
+      case 8: {


Redundant, there is no case 8.

src/shared/containers/SetOrg.tsx

Co-authored-by: Daniel Campbell <[email protected]>

…on in wizard

bednar · 2023-06-14T11:28:50Z

@mavarius Thanks for your review, I've fulfilled all requirements... the Java and C# wizards also support the TSM engine, so they can be used with HomepageContentsTSM.

mavarius

Looks good. The only thing left is to ensure the dropdown doesn't get cut off and scrolls instead. I think after that we'll be good to go. Thanks!

mavarius · 2023-06-22T21:15:10Z

src/homepageExperience/components/OptionAccordion/QueryDataAccordion.tsx

@@ -46,6 +46,8 @@ export const QueryDataAccordion: FC = () => {
  const languageList = {


Let's list these alphabetically like the "Write Data" list. Also, it is getting cut off, it should scroll like the other one.

The list is sorted alphabetically.

I'm unable to modify the scss to display the entire list. For the Add Data dropdown, it works because there's sufficient space beneath it:

A quick but inelegant solution would be to set the max-height to 75px. However, this seems like an unsightly workaround to me.

Found a fix for the dropdown issue. In the OptionAccordion.scss file, make this change:

This will allow the section with the dropdown to appear above the others like this:

mavarius

Looks good, I think it's ready for merge once the tests are passed.

mavarius · 2023-06-29T16:20:34Z

src/homepageExperience/components/OptionAccordion/QueryDataAccordion.tsx

@@ -80,7 +80,7 @@ export const QueryDataAccordion: FC = () => {
          />
          <OptionAccordionElement
            elementTitle="Application Code"
-            elementDescription="Write data into your database directly with your application code."
+            elementDescription="Query your data directly with your application code."


bednar · 2023-06-30T07:27:28Z

@mavarius, the ci/circleci: monitor-ci-tests is dependent on API_KEY and MONITOR_CI_BRANCH environment variables, which are not propagated to the forked repository:

I've created a new PR with the same content within this repository and all checks have passed: #6753. Could you please approve #6753?

Thank you for your reviews. 👍

bednar · 2023-07-13T05:43:29Z

@mavarius thanks, closing this PR because the #6753 is merged

Sciator added 4 commits May 16, 2023 13:03

docs: install, write, query influxdb3-go

6281938

docs: custom iterator influxdb3-go

59e57d8

docs: fixes

0b2ad3e

docs: fixed newline

84e8bea

mavarius self-assigned this May 30, 2023

fix: code style

92bd1df

bednar changed the title ~~docs: install, write, query influxdb3-go~~ docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp Jun 1, 2023

bednar added 3 commits June 1, 2023 09:46

feat: add C# wizard for IOX

e0c39b4

feat: add Java wizard for IOX

6f598f5

fix: escape database name

11df75a

bednar changed the title ~~docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp~~ docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp, influxdb3-java Jun 2, 2023

bednar added 2 commits June 7, 2023 16:51

docs: transfer to InfluxCommunity

cdcded4

docs: correct version for Java client

4faa217

bednar marked this pull request as ready for review June 9, 2023 11:23

bednar requested a review from a team as a code owner June 9, 2023 11:23

mavarius requested changes Jun 13, 2023

View reviewed changes

bednar and others added 12 commits June 14, 2023 06:58

Merge branch 'influxdata:master' into docs-influxdb3-go-getting-started

5301367

fix: use serverless Homepage

8ea785d

feat: client library section uses new wizard

1b6945b

fix: rename IOxExample to WriteQueryExample

c483b33

fix: rename InfluxDB3.Examples.IOx to InfluxDB3.Examples

5788278

fix: event name

4348da0

Co-authored-by: Daniel Campbell <[email protected]>

chore: apply suggestions from code review

1964c67

Co-authored-by: Daniel Campbell <[email protected]>

fix: scope of the event functions, removed unnecessary steps definiti…

fb2a955

…on in wizard

fix: requirements for Java client

8dd7285

feat: add tsm example for java wizard

666053e

feat: add tsm example for c# wizard

1440d21

feat: add java csharp wizard to TSM homepage

d08534a

bednar requested a review from mavarius June 14, 2023 11:29

mavarius reviewed Jun 22, 2023

View reviewed changes

bednar added 3 commits June 23, 2023 10:16

Merge branch 'influxdata:master' into docs-influxdb3-go-getting-started

f9cd6d7

fix: correct order of languages in list

7eb6d53

fix: display language list

1e40ebf

bednar requested a review from mavarius June 29, 2023 06:55

mavarius approved these changes Jun 29, 2023

View reviewed changes

bednar enabled auto-merge June 30, 2023 07:09

Merge branch 'influxdata:master' into docs-influxdb3-go-getting-started

8ab32f4

mavarius mentioned this pull request Jun 30, 2023

docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp, influxdb3-java #6753

Merged

5 tasks

bednar closed this Jul 13, 2023

auto-merge was automatically disabled July 13, 2023 05:43
Pull request was closed

bednar deleted the docs-influxdb3-go-getting-started branch July 13, 2023 05:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(clients): add onboarding for new `influxdb3-go`, `influxdb3-csharp`, `influxdb3-java` #6690

docs(clients): add onboarding for new `influxdb3-go`, `influxdb3-csharp`, `influxdb3-java` #6690

Sciator commented May 16, 2023 •

edited by bednar

Loading

mavarius left a comment

mavarius Jun 9, 2023

bednar Jun 14, 2023

mavarius Jun 12, 2023

bednar Jun 14, 2023

mavarius Jun 12, 2023

bednar Jun 14, 2023

mavarius Jun 12, 2023

bednar Jun 14, 2023

mavarius Jun 12, 2023

bednar Jun 14, 2023

mavarius Jun 13, 2023

bednar Jun 14, 2023

mavarius Jun 13, 2023

bednar Jun 14, 2023

mavarius Jun 13, 2023

bednar Jun 14, 2023 •

edited

Loading

mavarius Jun 13, 2023

bednar Jun 14, 2023

bednar commented Jun 14, 2023

mavarius left a comment

mavarius Jun 22, 2023

bednar Jun 23, 2023

mavarius Jun 28, 2023 •

edited

Loading

mavarius left a comment

mavarius Jun 29, 2023

bednar commented Jun 30, 2023

bednar commented Jul 13, 2023

		@@ -46,6 +46,8 @@ export const QueryDataAccordion: FC = () => {
		const languageList = {

docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp, influxdb3-java #6690

docs(clients): add onboarding for new influxdb3-go, influxdb3-csharp, influxdb3-java #6690

Conversation

Sciator commented May 16, 2023 • edited by bednar Loading

GO

CSharp

Java

Checklist

mavarius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bednar Jun 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bednar commented Jun 14, 2023

mavarius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mavarius Jun 28, 2023 • edited Loading

Choose a reason for hiding this comment

mavarius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bednar commented Jun 30, 2023

bednar commented Jul 13, 2023

docs(clients): add onboarding for new `influxdb3-go`, `influxdb3-csharp`, `influxdb3-java` #6690

docs(clients): add onboarding for new `influxdb3-go`, `influxdb3-csharp`, `influxdb3-java` #6690

Sciator commented May 16, 2023 •

edited by bednar

Loading

bednar Jun 14, 2023 •

edited

Loading

mavarius Jun 28, 2023 •

edited

Loading