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

documentation: tutorial/agent-on-docker #516

Merged
merged 15 commits into from
Jul 2, 2020

Conversation

vankichi
Copy link
Contributor

Description:

I created a document about tutorial/agent-on-docker, and fixed type and some parameter setting about document of get-started.
Also, I added the CreateIndex() method in example code for running the standalone agent on k8s and docker.

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.14.3
  • Docker Version: 19.03.8
  • Kubernetes Version: 1.18.2
  • NGT Version: 1.11.5

Types of changes:

  • Bug fix [type/bug]
  • New feature [type/feature]
  • Add tests [type/test]
  • Security related changes [type/security]
  • Add documents [type/documentation]
  • Refactoring [type/refactoring]
  • Update dependencies [type/dependency]
  • Update benchmarks and performances [type/bench]
  • Update CI [type/ci]

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Checklist:

  • I have read the CONTRIBUTING document.
  • I have checked open Pull Requests for the similar feature or fixes?
  • I have added tests and benchmarks to cover my changes.
  • I have ensured all new and existing tests passed.
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly.

@vankichi vankichi requested review from kevindiu and hlts2 June 24, 2020 08:28
@pull-assistant
Copy link

pull-assistant bot commented Jun 24, 2020

Score: 0.87

Best reviewed: commit by commit


Optimal code review plan (3 warnings)

     ♻️ add Insert method to example code

     📝 ♻️ update get-started

     ♻️ fix indent

     📝 create tutotial/agent-on-docker

📝 fix grammer

...cs/tutorial/agent-on-docker.md 55% changes removed in ♻️ adopt comm...

docs/tutorial/get-started.md 50% changes removed in ♻️ adopt comm...

     📝 add command

     📝 fix

♻️ adopt comments

...cs/tutorial/agent-on-docker.md 43% changes removed in ♻️ fix typo

     ♻️ update document

     ♻️ update document

♻️ fix

...cs/tutorial/agent-on-docker.md 50% changes removed in ♻️ fix word

     ♻️ fix word

     ♻️ fix typo

     ♻️ update

     Merge branch 'master' into documentation/tutorial/craete-agent-on-dock...

Powered by Pull Assistant. Last update 346cac2 ... 9d45653. Read the comment docs.

Copy link
Contributor

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

Could you please confirm my suggestions ?:bow:

docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/get-started.md Outdated Show resolved Hide resolved
docs/tutorial/get-started.md Outdated Show resolved Hide resolved
example/client/agent/main.go Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/get-started.md Outdated Show resolved Hide resolved
docs/tutorial/get-started.md Outdated Show resolved Hide resolved
docs/tutorial/get-started.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Show resolved Hide resolved
@vankichi
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/tutorial/craete-agent-on-docker

@vdaas-ci vdaas-ci force-pushed the documentation/tutorial/craete-agent-on-docker branch from 2a0fc37 to 9d7907b Compare June 29, 2020 06:35
docs/tutorial/agent-on-docker.md Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
hlts2
hlts2 previously approved these changes Jun 30, 2020
Copy link
Contributor

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM

@vankichi
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/tutorial/craete-agent-on-docker

hlts2
hlts2 previously approved these changes Jun 30, 2020
Copy link
Contributor

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM

@vankichi
Copy link
Contributor Author

/rebase
/format

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/tutorial/craete-agent-on-docker

@vdaas-ci vdaas-ci force-pushed the documentation/tutorial/craete-agent-on-docker branch from ba3b8a4 to 8f679ba Compare June 30, 2020 03:07
@vdaas-ci
Copy link
Collaborator

[FORMAT] Updating license headers and formatting go codes triggered by vankichi.

docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
example/helm/values-standalone-agent-ngt.yaml Outdated Show resolved Hide resolved
rinx
rinx previously approved these changes Jul 1, 2020
Copy link
Contributor

@rinx rinx left a comment

Choose a reason for hiding this comment

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

I checked. LGTM

kevindiu
kevindiu previously approved these changes Jul 2, 2020
Copy link
Contributor

@kevindiu kevindiu left a comment

Choose a reason for hiding this comment

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

LGTM

kpango
kpango previously approved these changes Jul 2, 2020
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

LGTM

@kpango
Copy link
Collaborator

kpango commented Jul 2, 2020

/rebase
/format

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jul 2, 2020

[REBASE] Rebase triggered by kpango for branch: documentation/tutorial/craete-agent-on-docker

Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vdaas-ci vdaas-ci dismissed stale reviews from kpango, kevindiu, and rinx via 3053ead July 2, 2020 03:27
@vdaas-ci vdaas-ci force-pushed the documentation/tutorial/craete-agent-on-docker branch from 0b09127 to 3053ead Compare July 2, 2020 03:27
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jul 2, 2020

[FORMAT] Updating license headers and formatting go codes triggered by kpango.

@kpango kpango merged commit 76908b6 into master Jul 2, 2020
@kpango kpango deleted the documentation/tutorial/craete-agent-on-docker branch July 2, 2020 03:34
kevindiu pushed a commit that referenced this pull request Jul 2, 2020
* ♻️ add Insert method to example code

Signed-off-by: vankichi <kyukawa315@gmail.com>

* 📝 ♻️ update get-started

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ fix indent

Signed-off-by: vankichi <kyukawa315@gmail.com>

* 📝 create tutotial/agent-on-docker

Signed-off-by: vankichi <kyukawa315@gmail.com>

* 📝 fix grammer

Signed-off-by: vankichi <kyukawa315@gmail.com>

* 📝 add command

Signed-off-by: vankichi <kyukawa315@gmail.com>

* 📝 fix

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ adopt comments

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ update document

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ update document

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ fix

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ fix word

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ fix typo

Signed-off-by: vankichi <kyukawa315@gmail.com>

* ♻️ update

Signed-off-by: vankichi <kyukawa315@gmail.com>

Co-authored-by: Yusuke Kato <i.can.feel.gravity@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants