crane icon indicating copy to clipboard operation
crane copied to clipboard
verified publisher icon gocrane

docs: Developer Guide

Open yashpimple opened this issue 3 years ago • 2 comments

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

yashpimple avatar Aug 19 '22 13:08 yashpimple

🎊 PR Preview 0fcf00143ab05a3f1457aadbbfb9526ed12c2aeb has been successfully built and deployed to https://gocrane-crane-preview-pr-499.surge.sh

:clock1: Build time: 6.621s

🤖 By surge-preview

github-actions[bot] avatar Aug 19 '22 13:08 github-actions[bot]

The developer guide seems not complete.

I have some advice for you.

The developer guide should focus on how to dev based on the developer. The guide doesn't need to describe how to install Crane in detail, just a paste link is enough.

We should focus on these tasks and describe them in detail:

  • How to build binary and images from code https://github.com/gocrane/crane/blob/702aa9c78327840b494c837674f9478b9bef8049/Makefile#L103-L165
  • How to prepare local environments
    • go version
    • application bootstrap
    • the local application connects to the remote k8s cluster.
    • application debug

zsnmwy avatar Aug 20 '22 13:08 zsnmwy

Develop Guide is already contains these content.

qmhu avatar Nov 07 '22 11:11 qmhu