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

workshop docs for odbcListDrivers() and odbcListDataSources() #649

Merged
merged 4 commits into from
Dec 6, 2023

Conversation

simonpcouch
Copy link
Collaborator

When getting started, I initially had trouble figuring out how to get a driver / DSN correctly configured. It seemed the existing docs assumed I had a connection configured already, though ?odbcListDataSources() directed folks to the README if they happen to stumble across it.

As of #647, we now direct people to ?odbcListDataSources() and ?odbcListDrivers() from the ?dbConnect() docs. This PR revamps the docs for those pages.

After this PR, I'd like to revisit the installation docs in the README and setup.md. I think README could be a strong venue to establish the mental model and link out to other places for the nitty gritty. I do see the benefits of listing out all of the right brew install or apt-get incantations in one place, though that content seems 1) more developer-focused, as many docs I've seen online seem to imply that a user is likely to be working in a context where those drivers are already installed, and 2) well-served by good setup helpers (see #634).

@simonpcouch
Copy link
Collaborator Author

urlchecker::url_check() comes back clean.

R/Connection.R Outdated Show resolved Hide resolved
Copy link
Member

@hadley hadley 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! There are many comments to hopefully help get my mental model in your head and hence in the heads of users 😄

R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Outdated Show resolved Hide resolved
Copy link
Member

@hadley hadley left a comment

Choose a reason for hiding this comment

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

LGTM!

R/Connection.R Outdated Show resolved Hide resolved
R/Connection.R Show resolved Hide resolved
R/Connection.R Show resolved Hide resolved
@simonpcouch simonpcouch merged commit 03a425a into main Dec 6, 2023
19 checks passed
@simonpcouch simonpcouch deleted the odbcList-docs branch December 6, 2023 16:59
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.

2 participants