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: restructure and consistency #6511

Merged
merged 1 commit into from
Jun 27, 2023
Merged

docs: restructure and consistency #6511

merged 1 commit into from
Jun 27, 2023

Conversation

lostmygithubaccount
Copy link
Member

This PR reorganizes the Ibis documentation, adds redirects, corrects links, and hopefully doesn't break anything. Some updates for consitency were made. Several follow up PRs are needed, but this should serve as a merge-able reorganization.

The following changes were made:

  • adjust SUMMARY.md to reflect new structure
  • add /concept/ and move conceptual documentation there
  • add /tutorial/ and move tutorial (learning Ibis) guides there
  • move /how_to/ as a top-level directory and clean up slightly
  • move /backends/ as a top-level directory and add support matrix underneath
    it
  • rename /api/ to /reference/
  • remove /user_guide/, moving content appropriately
  • various renaming of links/headers to be more consistent
  • lowercase all backend filesnames (use header for display name; right now,
    pandas isn't showing in the correct order on the website)
  • removed some unused examples
  • add redirects for old links

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@lostmygithubaccount lostmygithubaccount mentioned this pull request Jun 22, 2023
27 tasks
@lostmygithubaccount lostmygithubaccount marked this pull request as ready for review June 22, 2023 17:38
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

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

Thanks for putting this all together @lostmygithubaccount ! It's often a thankless task, so again, thank you.

A few small tweaks and a few suggestions (although most of those can be done in followups)

docs/SUMMARY.md Show resolved Hide resolved
docs/SUMMARY.md Show resolved Hide resolved
docs/backends/index.md Show resolved Hide resolved
docs/backends/impala.md Outdated Show resolved Hide resolved
docs/backends/dask.md Outdated Show resolved Hide resolved
docs/backends/pandas.md Outdated Show resolved Hide resolved
docs/concept/backends.md Outdated Show resolved Hide resolved
docs/concept/backends.md Show resolved Hide resolved
fix extending operations

fix prettier

update per feedback
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

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

This looks good to me!

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