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

Add docs for ADA #631

Merged
merged 6 commits into from
Aug 17, 2020
Merged

Add docs for ADA #631

merged 6 commits into from
Aug 17, 2020

Conversation

nakabonne
Copy link
Member

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

NONE

@pipecd-bot pipecd-bot requested review from gkuga and nghialv August 17, 2020 02:14
@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 21.38%. This pull request does not change code coverage.

@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 21.38%. This pull request does not change code coverage.

nghialv
nghialv reviewed Aug 17, 2020
View reviewed changes
docs/content/en/docs/user-guide/automated-deployment-analysis.md Outdated

The ADA analyzes the new version by periodically performing queries against the [Analysis Provider](/docs/concepts/#analysis-provider) and evaluating the results.

### Getting started
Copy link
Member

Choose a reason for hiding this comment

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

This can be considered as the Prerequisites

Copy link
Member Author

Choose a reason for hiding this comment

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

This chapter is written for those who want to try it out anyway. So other than Getting started, Configurations or Settings may be appropriate.

I guess Prerequisites is used when telling dependencies and terms for use.

Copy link
Member

@nghialv nghialv Aug 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Yes. What I wanted to say is the configuration in piped about adding the providers can be considered as the Prerequisites. The rest part (configuration inside the pipeline) can be in Configuration

For example:

### Prerequisites

Before enabling ANA inside the pipeline, all required Analysis Providers must be configured in the Piped Configuration.
...
https://pipecd.dev/docs/operator-manual/piped/adding-an-analysis-provider/


### Configuration

Copy link
Member Author

Choose a reason for hiding this comment

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

Now it turned out! I will be happy to append it.

@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 21.38%. This pull request does not change code coverage.

@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 21.38%. This pull request does not change code coverage.

@nakabonne
Copy link
Member Author

Fixed

@nghialv
Copy link
Member

nghialv commented Aug 17, 2020

/approve

@pipecd-bot
Copy link
Collaborator

APPROVE

This pull request is APPROVED by nghialv.

Approvers can cancel the approval by writing /approve cancel in a comment. Any additional commits also will change this pull request to be not-approved.

@pipecd-bot
Copy link
Collaborator

COVERAGE

Code coverage for golang is 21.38%. This pull request does not change code coverage.

@pipecd-bot pipecd-bot merged commit cf70192 into master Aug 17, 2020
@pipecd-bot pipecd-bot deleted the ada-docs branch August 17, 2020 09:10
@pipecd-bot pipecd-bot mentioned this pull request Aug 20, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nghialv nghialv nghialv left review comments

@gkuga gkuga Awaiting requested review from gkuga

Assignees
No one assigned
Labels
approved area/docs area/site release-note-none size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nakabonne @pipecd-bot @nghialv