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

Update tutorial to support v1 #1009

Merged
merged 12 commits into from
Feb 19, 2021
Merged

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Feb 16, 2021

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

Description:

Update tutorial document for v1
changes are below:

  • update and fix docs/tutorial/get-started.md and docs/tutorial/agent-on-docker.md
  • update helm charts to support v1
  • update exapmle code for tutorial to support v1

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.15.8
  • Docker Version: 19.03.8
  • Kubernetes Version: 1.18.2
  • NGT Version: 1.12.3

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.

Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi self-assigned this Feb 16, 2021
@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - add changelog comment
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase master
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

docs/tutorial/agent-on-docker.md Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Show resolved Hide resolved
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 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
docs/tutorial/agent-on-docker.md Show resolved Hide resolved
Signed-off-by: vankichi <kyukawa315@gmail.com>
@github-actions github-actions bot added size/XXL and removed size/L labels Feb 18, 2021
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/tutorial/get-started.md|544 col 6| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Client
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/tutorial/get-started.md|549 col 17| Please add a punctuation mark at the end of paragraph. (PUNCTUATION_PARAGRAPH_END)
Suggestions: Index., Index!, Index?, Index:, Index,, Index;
Rule: https://community.languagetool.org/rule/show/PUNCTUATION_PARAGRAPH_END?lang=en-US
Category: PUNCTUATION
docs/tutorial/get-started.md|625 col 12| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: B
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/tutorial/get-started.md|635 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Go
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
@vankichi vankichi changed the title [WIP] update tutorial/agent-on-docker for v1 [patch] update tutorial/agent-on-docker for v1 Feb 18, 2021
@vankichi vankichi marked this pull request as ready for review February 18, 2021 07:52
@vankichi
Copy link
Contributor Author

/rebase
/format

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/docs/update-tutorial-docs

@vdaas-ci
Copy link
Collaborator

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

@vankichi vankichi changed the title [patch] update tutorial/agent-on-docker for v1 update tutorial/agent-on-docker for v1 Feb 18, 2021
@vankichi vankichi changed the title update tutorial/agent-on-docker for v1 update tutorial to support v1 Feb 18, 2021
@vankichi vankichi changed the title update tutorial to support v1 Update tutorial to support v1 Feb 18, 2021
Signed-off-by: vankichi <kyukawa315@gmail.com>
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
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.

Others looks good to me.

docs/tutorial/agent-on-docker.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
example/client/agent/main.go 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 Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
docs/tutorial/get-started.md Show resolved Hide resolved
vankichi and others added 4 commits February 19, 2021 11:46
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
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-scylla.yaml Outdated Show resolved Hide resolved
vankichi and others added 4 commits February 19, 2021 15:41
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
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 Outdated Show resolved Hide resolved
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 Show resolved Hide resolved
docs/tutorial/agent-on-docker.md Outdated Show resolved Hide resolved
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 kpango merged commit 0351002 into master Feb 19, 2021
@kpango kpango deleted the documentation/docs/update-tutorial-docs branch February 19, 2021 07:25
@vdaas-ci vdaas-ci mentioned this pull request Feb 19, 2021
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