Add developer-guide.md and some images. #512

JaneConan · 2022-08-22T03:02:12Z

What type of PR is this?

For crane's developer, Add a developer guidebook.

This Developer's Guide document to let new craner to know how to contribute code.

What this PR does / why we need it:

Introduce to clone the project.
Introduce to build binary and images from code.

Which issue(s) this PR fixes:

Implement #459

Special notes for your reviewer:

For local developers, we also need to solicit suggestions after the release of the manual so that we can complete it. Thx~

github-actions · 2022-08-22T03:02:32Z

♻️ PR Preview 71eb198 has been successfully destroyed since this PR has been closed.

_{🤖 By surge-preview}

zsnmwy · 2022-08-22T03:36:35Z

Thanks for your pull request.

Crane uses the mkdocs to build web docs.
Please make your docs adjust mkdocs.
It's easy to complete it.

python env 3.x

install packages

crane/.github/workflows/preview.yml

Lines 25 to 29 in a5cc718

    
           - uses: actions/setup-python@v2 
        
             with: 
        
               python-version: "3.9" 
        
           - run: pip install mkdocs-material mkdocs-static-i18n mike

mkdocs local preview
```
mkdocs serve -a 127.0.0.1:9999
```
Add docs path to mkdocs.yml
Change the format of your docs.

You can ref to the complete docs.
Please ensure that the directory is clearly structured.

JaneConan · 2022-08-22T03:49:25Z

THX a lot~

Let me have a try~

And I will implement this md with mkdocs.yml

Next, I push again~

zsnmwy · 2022-08-22T04:39:13Z

If possible, I hope the docs include these items.

#499 (comment)

JaneConan · 2022-08-22T06:26:33Z

If possible, I hope the docs include these items.

#499 (comment)

Sure~

How to build binary and images from code

That means "Don't use makefile, just use bash or cmd command line?"

How to prepare local environments
go version
application bootstrap
the local application connects to the remote k8s cluster.
application debug

Can we put it in the next sprint? I'm also studying and researching these things.

And I suggest we ask to our friends again, what else is needed?

Thx~(^_^)

github-actions · 2022-08-22T06:56:48Z

🎉 Successfully Build Images.
Now Support ARM Platforms.
Comment Post Time: 2022-08-22 23:10
Git Version: 71eb198

Docker Registry

Overview: https://hub.docker.com/u/gocrane

Image	Pull Command
crane-agent:pr-512-71eb198	docker pull gocrane/crane-agent:pr-512-71eb198
dashboard:pr-512-71eb198	docker pull gocrane/dashboard:pr-512-71eb198
metric-adapter:pr-512-71eb198	docker pull gocrane/metric-adapter:pr-512-71eb198
craned:pr-512-71eb198	docker pull gocrane/craned:pr-512-71eb198

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=gocrane/craned \
                   --set craned.image.tag=pr-512-71eb198 \
                   --set metricAdapter.image.repository=gocrane/metric-adapter \
                   --set metricAdapter.image.tag=pr-512-71eb198 \
                   --set craneAgent.image.repository=gocrane/crane-agent \
                   --set craneAgent.image.tag=pr-512-71eb198 \
                   --set cranedDashboard.image.repository=gocrane/dashboard \
                   --set cranedDashboard.image.tag=pr-512-71eb198 crane/crane

Coding Registry

Overview: https://finops.coding.net/public-artifacts/gocrane/crane/packages

Image	Pull Command
crane-agent:pr-512-71eb198	docker pull finops-docker.pkg.coding.net/gocrane/crane/crane-agent:pr-512-71eb198
dashboard:pr-512-71eb198	docker pull finops-docker.pkg.coding.net/gocrane/crane/dashboard:pr-512-71eb198
metric-adapter:pr-512-71eb198	docker pull finops-docker.pkg.coding.net/gocrane/crane/metric-adapter:pr-512-71eb198
craned:pr-512-71eb198	docker pull finops-docker.pkg.coding.net/gocrane/crane/craned:pr-512-71eb198

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=finops-docker.pkg.coding.net/gocrane/crane/craned \
                   --set craned.image.tag=pr-512-71eb198 \
                   --set metricAdapter.image.repository=finops-docker.pkg.coding.net/gocrane/crane/metric-adapter \
                   --set metricAdapter.image.tag=pr-512-71eb198 \
                   --set craneAgent.image.repository=finops-docker.pkg.coding.net/gocrane/crane/crane-agent \
                   --set craneAgent.image.tag=pr-512-71eb198 \
                   --set cranedDashboard.image.repository=finops-docker.pkg.coding.net/gocrane/crane/dashboard \
                   --set cranedDashboard.image.tag=pr-512-71eb198 crane/crane

Ghcr Registry

Overview: https://github.com/orgs/gocrane/packages?repo_name=crane

Image	Pull Command
crane-agent:pr-512-71eb198	docker pull ghcr.io/gocrane/crane/crane-agent:pr-512-71eb198
dashboard:pr-512-71eb198	docker pull ghcr.io/gocrane/crane/dashboard:pr-512-71eb198
metric-adapter:pr-512-71eb198	docker pull ghcr.io/gocrane/crane/metric-adapter:pr-512-71eb198
craned:pr-512-71eb198	docker pull ghcr.io/gocrane/crane/craned:pr-512-71eb198

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=ghcr.io/gocrane/crane/craned \
                   --set craned.image.tag=pr-512-71eb198 \
                   --set metricAdapter.image.repository=ghcr.io/gocrane/crane/metric-adapter \
                   --set metricAdapter.image.tag=pr-512-71eb198 \
                   --set craneAgent.image.repository=ghcr.io/gocrane/crane/crane-agent \
                   --set craneAgent.image.tag=pr-512-71eb198 \
                   --set cranedDashboard.image.repository=ghcr.io/gocrane/crane/dashboard \
                   --set cranedDashboard.image.tag=pr-512-71eb198 crane/crane

docs/developer-guide.md

zsnmwy · 2022-08-22T14:12:56Z

If possible, I hope the docs include these items.
#499 (comment)

Sure~

How to build binary and images from code

That means "Don't use makefile, just use bash or cmd command line?"

How to prepare local environments

go version

application bootstrap

the local application connects to the remote k8s cluster.

application debug

Can we put it in the next sprint? I'm also studying and researching these things.

And I suggest we ask to our friends again, what else is needed?

Thx~(^^_)

Makefile is all right.

Sure, I hope your next pr.

JaneConan · 2022-08-22T14:31:20Z

「weopen star」☆⌒(*＾-゜)v THX for @zsnmwy @qmhu !! Go! Go! Go! to next star~

qmhu

/LGTM

qmhu · 2022-08-22T16:18:05Z

Thanks for you effort, welcome to join crane 👍

zsnmwy

/LGTM

Add developer-guide.md and some images.

6c5fa0d

github-actions bot added the documentation Improvements or additions to documentation label Aug 22, 2022

fix developer-guide.md words, images description

751e977

add developer-guide docs link & multilingual words

225d7a3

zsnmwy requested changes Aug 22, 2022

View reviewed changes

docs/developer-guide.md Outdated Show resolved Hide resolved

docs/developer-guide.md Outdated Show resolved Hide resolved

fix images url and note style with mkdocs-material

5d6631e

fix note with mkdocs-material admonitions

71eb198

JaneConan requested a review from zsnmwy August 22, 2022 16:00

qmhu approved these changes Aug 22, 2022

View reviewed changes

zsnmwy approved these changes Aug 22, 2022

View reviewed changes

zsnmwy merged commit 149f15d into gocrane:main Aug 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add developer-guide.md and some images. #512

Add developer-guide.md and some images. #512

JaneConan commented Aug 22, 2022

github-actions bot commented Aug 22, 2022 •

edited

Loading

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022 •

edited

Loading

github-actions bot commented Aug 22, 2022 •

edited

Loading

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022

qmhu left a comment

qmhu commented Aug 22, 2022

zsnmwy left a comment

Add developer-guide.md and some images. #512

Add developer-guide.md and some images. #512

Conversation

JaneConan commented Aug 22, 2022

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

github-actions bot commented Aug 22, 2022 • edited Loading

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022 • edited Loading

github-actions bot commented Aug 22, 2022 • edited Loading

Docker Registry

Coding Registry

Ghcr Registry

zsnmwy commented Aug 22, 2022

JaneConan commented Aug 22, 2022

qmhu left a comment

Choose a reason for hiding this comment

qmhu commented Aug 22, 2022

zsnmwy left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 22, 2022 •

edited

Loading

JaneConan commented Aug 22, 2022 •

edited

Loading

github-actions bot commented Aug 22, 2022 •

edited

Loading