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

Update of the documentation for the 0.12.1 release #556

Merged
merged 6 commits into from
Jan 12, 2024

Conversation

zaleslaw
Copy link
Collaborator

@zaleslaw zaleslaw commented Jan 11, 2024

Closes #493 Closes #546 Closes #554

Extended the gradleReference documentation by adding a section on how to generate schema for existing SQL tables. This includes JDBC connection establishment and usage limitations and support for particular databases.
Added a new document providing a step-by-step guide on importing SQL metadata as a schema in Gradle project. In addition, minor documentation enhancements were made across multiple files to ensure clarity and precision. An unnecessary OpenAPI schemas section was removed from the schemasGradle.md file due to duplication.
```kotlin
dataframes {
schema {
data = "jdbc:mariadb://localhost:3306/imdb"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we add a link to this database?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I want to release example with this database and will update the links

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

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

Overall good docs :) Just many small things

I'd also like to review the other parts, added in #464 later.

docs/StardustDocs/topics/gradleReference.md Show resolved Hide resolved
docs/StardustDocs/topics/gradleReference.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/gradleReference.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/gradleReference.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/gradleReference.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/schemasImportSqlGradle.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/schemasImportSqlGradle.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/schemasImportSqlGradle.md Outdated Show resolved Hide resolved
docs/StardustDocs/topics/schemasImportSqlGradle.md Outdated Show resolved Hide resolved
…des a clearer instruction on how to import data. The change improves the language use in the guide, ensuring better understandability for users following the instructions for importing schema data from an SQL table or query.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants