Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Update documentation link #263

Merged
merged 1 commit into from
Oct 24, 2022
Merged

Update documentation link #263

merged 1 commit into from
Oct 24, 2022

Conversation

williebsweet
Copy link
Contributor

Switch from the current readthedocs documentation to the Datafold hosted documentation, which is also open-source.

Switch from the current readthedocs documentation to the Datafold hosted documentation, which is also [open-source](https://github.com/datafold/datafold-docs/tree/main/docs/os_diff).
@erezsh
Copy link
Contributor

erezsh commented Oct 21, 2022

Page not found at root path: https://docs.datafold.com/os_diff/

Guides still mentions dbt: https://docs.datafold.com/guides/ci_guides_overview

imo The link to Join Us On Github should be just the repo https://github.com/datafold/data-diff, and not link the the README

@erezsh
Copy link
Contributor

erezsh commented Oct 21, 2022

Also, is it possible to use git submodule, or some other mechanism, so that the docs can stay on the same repo as the code? Having to do a separate docs PR, in a different repo from the code PR, will make keeping them in sync much harder.

@leoebfolsom
Copy link
Contributor

leoebfolsom commented Oct 21, 2022

@williebsweet I've added the Python API Reference and New Database Driver instructions to the datafold docs: https://github.com/datafold/datafold-docs/pull/32

@erezsh as part of this PR I changed the readme-specific link to just a simple link to the data-diff repo

@erezsh
Copy link
Contributor

erezsh commented Oct 21, 2022

@leoebfolsom There are some problems with this version of the Python API

  • There is no side menu for quickly jumping around
  • there are no links. for example, in "See Also", clicking object names doesn't send me to them.
  • Most importantly, this is not auto-generated. How will I keep it in sync with the docstrings?

@williebsweet
Copy link
Contributor Author

Resolved the above by just linking out to the readthedocs for the Python API.

@erezsh should we remove the rest of the documentation from readthedocs so that we don't have to keep both up to date?

@erezsh erezsh self-requested a review October 24, 2022 13:44
@erezsh erezsh merged commit 80bbccb into master Oct 24, 2022
@williebsweet williebsweet deleted the will-update-documentation-link branch April 3, 2023 00:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants