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

Add quick start section to contributor docs #1766

Merged
merged 2 commits into from
Sep 2, 2020

Conversation

seanmalloy
Copy link
Member

@seanmalloy seanmalloy commented Sep 1, 2020

Description
Added a quick start section to the contributing documentation. The purpose of this documentation is to help new contributors get started working with the external-dns project.

Updated docs/contributing/getting-started.md with recommend local development workflow. Removed documentation from README.md for compiling from source.

Is related to #1558

Checklist

  • Unit tests updated
  • End user documentation updated
  • CHANGELOG.md updated, use section "Unreleased"

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 1, 2020
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 1, 2020
@seanmalloy
Copy link
Member Author

/cc @tariq1890

@tariq1890 and @vinny-sabatini please review when you get a chance. Thanks!

@seanmalloy
Copy link
Member Author

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 1, 2020
Copy link
Contributor

@vinny-sabatini vinny-sabatini left a comment

Choose a reason for hiding this comment

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

Just one minor tweak here, the rest looks good to me

CHANGELOG.md Outdated Show resolved Hide resolved
@seanmalloy
Copy link
Member Author

@vinny-sabatini fixed. Good catch!

Copy link
Contributor

@vinny-sabatini vinny-sabatini left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@tariq1890 tariq1890 left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 1, 2020
@seanmalloy
Copy link
Member Author

/assign @Raffo @njuettner

Copy link
Member

@njuettner njuettner left a comment

Choose a reason for hiding this comment

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

/lgtm

@Raffo
Copy link
Contributor

Raffo commented Sep 2, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Raffo, seanmalloy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 2, 2020
@k8s-ci-robot k8s-ci-robot merged commit c6101aa into kubernetes-sigs:master Sep 2, 2020
@vinny-sabatini vinny-sabatini deleted the docs-round-4 branch September 14, 2020 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants