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

[DOC] documentation updates June 2024 #48

Merged
merged 22 commits into from
Jun 21, 2024

Conversation

dannymeijer
Copy link
Member

@dannymeijer dannymeijer commented Jun 10, 2024

Documentation updates

Description

  • Fixed spelling of and type annotations for Parameters across docstrings
  • Fixed broken links and unrecognized relative links
  • Fixed indentation for continuation lines in docstrings
  • Refactored README for legibility and clarity with a more defined structure and better formatting
  • General style and formatting improvements
  • Minor change to the layout of the pages (to better accommodate the reader)
  • No code changes were made as part of this PR

Testing

To build the docs:

  • check out the branch
  • run make docs
  • docsite will be hosted on your local machine

Related Issue

#38
#42

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation changes

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed

@dannymeijer dannymeijer changed the title 38 42 feature documentation update [DOC] documentation updates June 2024 Jun 10, 2024
- [x] Link to databricks workflow was broken: changed to https://www.databricks.com/product/workflows
- [x] link to argo was broken: changed to https://argoproj.github.io/
- [x] You can install Koheesio using either pip or poetry → added hatch
- [x] Link to contribution guideline was broken
- [x] Fix Github links
- [x] Reference to non-existing link `[]` removed
@dannymeijer dannymeijer marked this pull request as ready for review June 20, 2024 08:15
@dannymeijer dannymeijer requested a review from a team as a code owner June 20, 2024 08:15
@dannymeijer
Copy link
Member Author

dannymeijer commented Jun 20, 2024

I will merge main and resolve conflicts after initial peer review. This branch is based off 0.7 tag (on purpose) so that we can update docs on the standing version.

After (manual) deployment to 0.7, I will merge main and ensure that any conflicts gets resolved.

@dannymeijer
Copy link
Member Author

0.7.0 docs have been updated: https://engineering.nike.com/koheesio/0.7.0/

…ature-documentation-update

# Conflicts:
#	README.md
Copy link
Contributor

@riccamini riccamini left a comment

Choose a reason for hiding this comment

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

Looking good

@dannymeijer dannymeijer merged commit 4b2e015 into main Jun 21, 2024
12 checks passed
@dannymeijer dannymeijer deleted the 38-42-feature-documentation-update branch June 21, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOC] Wrong package manager in Contributing guide [DOC] Broken link in documentation
2 participants