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

[Docs] Adds tutorial and stepwise instructions for EXTERN #17501

Merged
merged 22 commits into from
Dec 19, 2024

Conversation

techdocsmith
Copy link
Contributor

  • Adds a tutorial for EXTERN to export data with MSQ

  • Fixes up the style of the EXTERN function reference
    This PR has:

  • [ x] been self-reviewed.

Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

Initial feedback, still testing the steps.

docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/tutorials/tutorial-extern.md Outdated Show resolved Hide resolved
docs/tutorials/tutorial-extern.md Outdated Show resolved Hide resolved
docs/tutorials/tutorial-extern.md Outdated Show resolved Hide resolved
```bash
./bin/start-druid
```

Copy link
Contributor

@ektravel ektravel Nov 25, 2024

Choose a reason for hiding this comment

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

After starting the Druid services, go to http://localhost:8888/ in your browser to access the web console.

docs/tutorials/tutorial-extern.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

I tested the steps for the local file system.

docs/tutorials/tutorial-extern.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
@ektravel
Copy link
Contributor

Not for this PR, but it would be good to standardize how we refer to SQL functions in this topic. Specifically when it comes to using code font.

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
techdocsmith and others added 4 commits November 26, 2024 11:25
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

A couple of nits. Otherwise, LGTM.

docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
docs/multi-stage-query/reference.md Outdated Show resolved Hide resolved
techdocsmith and others added 4 commits November 26, 2024 14:29
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Copy link
Contributor

@adarshsanjeev adarshsanjeev left a comment

Choose a reason for hiding this comment

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

Looks good to me overall!

- **Amazon S3**: `druid-s3-extensions`
- **GCS**: `google-extensions`
See [Loading core extensions](../configuration/extensions.md#loading-core-extensions) for more information.
1. Configure the additional properties for your cloud storage destination. Replace `{CLOUD}` with `s3` or `google` accordingly:
Copy link
Contributor

Choose a reason for hiding this comment

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

The numbering seems off here and in other places in the file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using 1. for all the numbers lets the build system maintain the numbers for easier editing. Markdown translates the numbers to <ol><li / ><li /><li /></ol>

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, got it! Thanks for explaining!

@techdocsmith techdocsmith merged commit 4648a41 into apache:master Dec 19, 2024
10 checks passed
@techdocsmith techdocsmith deleted the extern_tutorial branch December 19, 2024 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants