Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BSE-4389] Add Bodo Platform SDK Guide in the quick start. #84

Merged
merged 14 commits into from
Dec 30, 2024

Conversation

mbojanowski
Copy link
Member

@mbojanowski mbojanowski commented Dec 20, 2024

Changes included in this PR

Add Bodo Platform SDK Guide in the quick start. Where we have:

  • create cluster
  • run simple job
  • execute query
  • execute query using connector

also added missing reference in Bodo SDK Guide

image

Testing strategy

User facing changes

Checklist

  • Pipelines passed before requesting review. To run CI you must include [run CI] in your commit message.
  • I am familiar with the Contributing Guide
  • I have installed + ran pre-commit hooks.

@mbojanowski
Copy link
Member Author

We can create additional guide which is a little more simple but, then we will need to maintain two guides, which is not ideal.

Copy link
Collaborator

@ehsantn ehsantn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intention of the issue wasn't moving the guide. The intention is adding a very simple SDK example to the cloud quick start.

@mbojanowski mbojanowski requested a review from ehsantn December 20, 2024 15:43
docs/mkdocs.yml Outdated
Comment on lines 168 to 170
- Bodo Platform SDK: guides/using_bodo_platform/bodo_platform_sdk_guide.md
- Configuring Customer Managed VPC: guides/using_bodo_platform/customer_managed_vpc.md
- AWS PrivateLink: guides/using_bodo_platform/aws_private_link.md
- Troubleshooting: guides/using_bodo_platform/troubleshooting.md
- Bodo Platform SDK guide : guides/using_bodo_platform/bodo_platform_sdk_guide.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's undo this change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@mbojanowski
Copy link
Member Author

mbojanowski commented Dec 23, 2024

I got few improvements from @marquisdepolis:

  1. Rename similar sounding Bodo Platform SDK pages to explain what they are!
  • now we have Platform SDK Quick Start and Platform SDK Guide
  • we also agreed on removing docs/docs/installation_and_setup/platform_sdk.md as this is already in both Platform SDK Quick Start and Platform SDK Guide
  1. Put bodo platform sdk left hand side as second suggestion"
    image
    not sure about that as first I think user should also understood Platform in general.

  2. How to run a piece of code on a piece of data on one's laptop

    • this will require feature in Bodo Platform, right now not supported
  3. We should support reading in files from local environment

    • this also will require feature in Bodo Platform, right now not supported
  4. Add reference on source to be github, s3, workspace etc -- show how. Change code to read from a public s3 bucket and does some work on it - in the example

    • looks like we don't have public S3/Github with examples right now
  5. Change the search too to hide older pages:

  • search is not showing older pages, when you type Bodo SDK it will first show all pages that have Bodo and SDK but also it will show all pages with only Bodo or SDK thats why we got so many results
    image

@mbojanowski
Copy link
Member Author

mbojanowski commented Dec 23, 2024

I also changed some left menu list:

from:
image

to:
image

@mbojanowski
Copy link
Member Author

Form this:
image

to this:
image

Copy link
Collaborator

@ehsantn ehsantn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mbojanowski !

@mbojanowski mbojanowski merged commit ee7874c into main Dec 30, 2024
8 checks passed
@mbojanowski mbojanowski deleted the mati/BSE-4389 branch December 30, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants