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

Helpers task290 improve on boarding docs #295

Merged
merged 18 commits into from
Feb 21, 2025

Conversation

sonniki
Copy link
Contributor

@sonniki sonniki commented Feb 18, 2025

#290

  • Copied the missing docs/onboarding/kaizenflow.set_up_development_environment.how_to_guide.md from the kaizenflow repo
  • Removed outdated references to ZenHub and ZH Epics and Pipelines
  • Removed outdated references to Telegram
  • Added docs/onboarding/all.must_read_checklist.md: a short-ish list of must-read docs that should be presented to anyone joining, be it with the full or light onboarding
    • TODO: Make sure all the docs in the list are onboarding-agnostic, i.e. they do not contain specific references to either the full onboarding process (e.g. developing on the server) or the light onboarding process (e.g. working as intern on Kaizenflow)
  • Added a link to the must-read doc to docs/onboarding/all.onboarding_checklist.md
    • TODO: Create a "light onboarding checklist" doc with dev setup instructions for working on the laptop and the link to the same must-read list

@sonniki sonniki requested a review from gpsaggese February 18, 2025 22:07
@sonniki sonniki self-assigned this Feb 18, 2025
Copy link
Contributor

@gpsaggese gpsaggese left a comment

Choose a reason for hiding this comment

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

Great work! Let's keep the docs in shape

@sonniki
Copy link
Contributor Author

sonniki commented Feb 21, 2025

@gpsaggese, UPD

Copy link
Contributor

@gpsaggese gpsaggese left a comment

Choose a reason for hiding this comment

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

All good.

FYI One trick to avoid the monster PRs, when you realize that there is a problem, is to do a PR only running the linter and merge it. Then you pick up those changes from master and the PR has only your changes.

@gpsaggese gpsaggese merged commit e4f93ee into master Feb 21, 2025
3 of 4 checks passed
@gpsaggese gpsaggese deleted the HelpersTask290_Improve_on_boarding_docs branch February 21, 2025 18:32
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