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

Restructure document folder structure #444

Merged
merged 1 commit into from
Jun 8, 2020
Merged

Restructure document folder structure #444

merged 1 commit into from
Jun 8, 2020

Conversation

kevindiu
Copy link
Contributor

@kevindiu kevindiu commented Jun 8, 2020 •
edited
Loading

Description:

This PR restructure document folder structure and fix the corresponding link.

% tree ./docs
./docs
├── contributing
│   └── coding-style.md
├── overview
│   ├── about-vald.md
│   ├── architecture.md
│   └── component
│       └── index.md
├── support
│   └── contacts.md
├── tutorial
│   └── get-started.md
└── user-guides
    └── configuration.md

Related Issue:

How Has This Been Tested?:

Environment:

  • Golang 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.

@pull-assistant
Copy link

pull-assistant bot commented Jun 8, 2020 •
edited
Loading

Score: 1.00

Best reviewed: commit by commit

Optimal code review plan

     fix doc file path

Powered by Pull Assistant. Last update 55e0464 ... 55e0464. Read the comment docs.

@kevindiu kevindiu requested a review from hlts2 June 8, 2020 06:22
@kevindiu kevindiu changed the title [draft] fix doc file path [Draft] Restructure document folder structure Jun 8, 2020
@kevindiu
Copy link
Contributor Author

kevindiu commented Jun 8, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

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

@vdaas-ci vdaas-ci force-pushed the documentation/restructure_doc_path branch from ed11b1d to 52a6648 Compare June 8, 2020 06:41
hlts2
hlts2 previously approved these changes Jun 8, 2020
View reviewed changes
Copy link
Collaborator

@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

@kevindiu kevindiu requested a review from vankichi June 8, 2020 08:01
@kevindiu kevindiu marked this pull request as ready for review June 8, 2020 08:01
@kevindiu kevindiu changed the title [Draft] Restructure document folder structure Restructure document folder structure Jun 8, 2020
@vankichi
Copy link
Contributor

vankichi commented Jun 8, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

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

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

[REBASE] Failed to rebase.

@kevindiu kevindiu force-pushed the documentation/restructure_doc_path branch from 56da64c to 68dc2b7 Compare June 8, 2020 09:19
@kevindiu
Copy link
Contributor Author

kevindiu commented Jun 8, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

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

vankichi
vankichi previously approved these changes Jun 8, 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
/approve
/rebase
/approve

@kpango
Copy link
Collaborator

kpango commented Jun 8, 2020

LGTM
/approve
/rebase
/approve

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

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

@rinx
Copy link
Contributor

rinx commented Jun 8, 2020

/changelog

@vdaas-ci vdaas-ci force-pushed the documentation/restructure_doc_path branch from 68dc2b7 to 55e0464 Compare June 8, 2020 10:04
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 8, 2020

[CHANGELOG] Please edit the following lines.

#{PR_TITLE} (#444)

vdaas-ci
vdaas-ci approved these changes Jun 8, 2020
View reviewed changes
Copy link
Collaborator

@vdaas-ci vdaas-ci left a comment

Choose a reason for hiding this comment

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

[APPROVED] This PR is approved by kpango.

@vankichi vankichi merged commit 3e5dd41 into master Jun 8, 2020
@vankichi vankichi deleted the documentation/restructure_doc_path branch June 8, 2020 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdaas-ci vdaas-ci vdaas-ci approved these changes

@hlts2 hlts2 hlts2 left review comments

@vankichi vankichi vankichi left review comments

Assignees
No one assigned
Labels
area/helm priority/low size/S team/sre SRE team type/ci type/documentation
Projects
None yet
Milestone
No milestone
Development

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