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.

Sign up for GitHub

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

Jump to bottom

Documentation: About vald #374

Merged
merged 18 commits into from
May 28, 2020
Merged

Documentation: About vald #374

merged 18 commits into from
May 28, 2020

Conversation

kevindiu
Copy link
Contributor

@kevindiu kevindiu commented May 13, 2020 •
edited
Loading

Description:

Create Aboud Vald document. The table of content is as follow.

- [What is Vald?](#what-is-vald)
  - [What Vald can do?](#what-vald-can-do)
  - [Use cases](#use-cases)
- [Why Vald?](#why-vald)
- [How does Vald work?](#how-does-vald-work)
- [Try Vald](#try-vald)

What Vald can do? and Use cases section is copied from README.md.

The remaining task/question is as follow:

  • How to keep the consistency of the copied contents?

Related Issue:

How Has This Been Tested?:

Environment:

  • Golang Version: 1.14
  • Docker Version: 19.03.5
  • Kubernetes Version: 1.17.3
  • NGT Version: 1.9.1

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.

@pull-assistant
Copy link

pull-assistant bot commented May 13, 2020 •
edited
Loading

Score: 0.63

Best reviewed: commit by commit

Optimal code review plan (1 warning)

add about vald doc draft

docs/user/about-vald.md 63% changes removed in Apply suggestions fr...

     added how does vald works section

     add try vald section

     move about-vald to docs/overview

     link to readme instead of copy the content

     remove section

     Revert "remove section"

     Revert "link to readme instead of copy the content"

     Apply suggestions from code review

     Apply suggestions from code review

     Update docs/overview/about.md

     Apply suggestions from code review

     Apply suggestions from code review

     update README.md

     Apply suggestions from code review

     Apply suggestions from code review

     Apply suggestions from code review

     Merge branch 'master' into documentation/about_vald

Powered by Pull Assistant. Last update 7807759 ... e62059b. Read the comment docs.

hlts2
hlts2 requested changes May 14, 2020
View reviewed changes
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
kevindiu
kevindiu commented May 14, 2020
View reviewed changes
docs/overview/about.md Outdated Show resolved Hide resolved
vankichi
vankichi reviewed May 14, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

@kevindiu
I said you that is there anything contents forAbout.md before.
Did you think about it or ask any authors/contributors?

docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
@kevindiu
Copy link
Contributor Author

kevindiu commented May 18, 2020 •
edited
Loading

I think about it by myself. I think that it is better to keep it as simple as possible in this document as it is the introduction page for Vald.
@vankichi If you think this PR is LGTMed please proceed to author review :)

vankichi
vankichi reviewed May 19, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

@kevindiu
commented.
We will move get-started document from docs/user/get-started.md to docs/get-started/get-started.md due to our public document architecture.

docs/overview/about.md Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
@kevindiu
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by kevindiu for branch: documentation/about_vald

vankichi
vankichi previously approved these changes May 19, 2020
View reviewed changes
@vankichi
Copy link
Contributor

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/about_vald

hlts2
hlts2 requested changes May 19, 2020
View reviewed changes
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
docs/overview/about.md Outdated Show resolved Hide resolved
kevindiu
kevindiu commented May 19, 2020
View reviewed changes
docs/overview/about.md Outdated Show resolved Hide resolved
@hlts2
Copy link
Collaborator

hlts2 commented May 19, 2020

LGTM

@github-actions github-actions bot added size/L and removed size/M labels May 19, 2020
@kevindiu
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by kevindiu for branch: documentation/about_vald

@kevindiu
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by kevindiu for branch: documentation/about_vald

@hlts2
Copy link
Collaborator

hlts2 commented May 19, 2020

LGTM

@kevindiu
Copy link
Contributor Author

/rebase

@kevindiu
Copy link
Contributor Author

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by kevindiu for branch: documentation/about_vald

kevindiu and others added 17 commits May 25, 2020 07:48
@kevindiu @actions-user
add about vald doc draft
7807759
@kevindiu @actions-user
added how does vald works section
915bd3d
@kevindiu @actions-user
add try vald section
b9df93a
@kevindiu @actions-user
move about-vald to docs/overview
df76306
@kevindiu @actions-user
link to readme instead of copy the content
7df0dd3
@kevindiu @actions-user
remove section
3972fb4
@kevindiu @actions-user
Revert "remove section"
cb28e9f 
This reverts commit 47693b6.
@kevindiu @actions-user
Revert "link to readme instead of copy the content"
b0c08a0 
This reverts commit aa94d9c.
@kevindiu @hlts2 @actions-user
Apply suggestions from code review
f7262ce 
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
@kevindiu @vankichi @actions-user
Apply suggestions from code review
c240412 
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
@kevindiu @actions-user
Update docs/overview/about.md
c44d979
@kevindiu @vankichi @actions-user
Apply suggestions from code review
2e29c0d 
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
@kevindiu @vankichi
@hlts2 @actions-user
Apply suggestions from code review
46a22a8 
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
@kevindiu @actions-user
update README.md
cce35f8
@kevindiu @vankichi @actions-user
Apply suggestions from code review
2956901 
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
@kevindiu @rinx @actions-user
Apply suggestions from code review
df9f53a 
Co-authored-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@kevindiu @rinx @actions-user
Apply suggestions from code review
fd1c951 
Co-authored-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@vdaas-ci vdaas-ci dismissed stale reviews from hlts2 and kmrmt via fd1c951 May 25, 2020 07:48
vankichi
vankichi approved these changes May 27, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

LGTM
/rebase
@kpango @rinx Could you review it? It does not cost reviewing.
I'd like to get your feedbacks because of changing Vlad Main Feature word

@kpango
Copy link
Collaborator

kpango commented May 28, 2020

/rebase
/format
/approve

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by kpango for branch: documentation/about_vald

@vdaas-ci
Copy link
Collaborator

[REBASE] Failed to rebase.

kpango
kpango approved these changes May 28, 2020
View reviewed changes
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 1819055 into master May 28, 2020
@kpango kpango deleted the documentation/about_vald branch May 28, 2020 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rinx rinx rinx left review comments

@vankichi vankichi vankichi approved these changes

@kpango kpango kpango approved these changes

@hlts2 hlts2 hlts2 left review comments

@kmrmt kmrmt kmrmt left review comments

Assignees
No one assigned
Labels
priority/low size/L status/author-review type/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@kevindiu @vdaas-ci @vankichi @hlts2 @kpango @kmrmt @rinx