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

Readme revamp and Route53 tutorial #179

Merged
merged 17 commits into from
Oct 26, 2020
Merged

Readme revamp and Route53 tutorial #179

merged 17 commits into from
Oct 26, 2020

Conversation

ytsarev
Copy link
Member

@ytsarev ytsarev commented Oct 24, 2020

  • Split README to readable sections
  • Create CONTRIBUTING.md
  • Create CODEOWNERS
  • Add Route53 tutorial together with reference terraform code, sample k8gb values yaml files and Gslb sample CR

* Splitting to sections
* Create placeholders for important enhancements
@ytsarev
Copy link
Member Author

ytsarev commented Oct 24, 2020

guys, it is WIP, would love to get early feedback on the overall direction with docs

@somaritane it's inline with what we discussed in person
@donovanmuller I reused the abstract from your brilliant kubecon talk proposal
@k0da @kuritka dudes, any feedback/ideas is highly appreciated

Copy link
Collaborator

@kuritka kuritka left a comment

Choose a reason for hiding this comment

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

nice...!

*I found some minimal typos


For more advanced technical documentation and fully automated local installation steps, see below.
* Load balancing is based on timeproof DNS protocol which is perfect for global scope and extremely reliable
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* Load balancing is based on timeproof DNS protocol which is perfect for global scope and extremely reliable
* Load balancing is based on time proof DNS protocol which is perfect for global scope and extremely reliable

Copy link
Member Author

Choose a reason for hiding this comment

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

@kuritka not sure here, used as adjective https://en.wiktionary.org/wiki/timeproof . @donovanmuller please comment as a native speaker, thanks

Choose a reason for hiding this comment

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

Hey @ytsarev - is there anything we can link to that describes the DNS timeproof protocol? Google is failing me.

172.17.0.7
```
* One of your workers should already return DNS responses constructed by Gslb based on service health information
* If edgeDNS was configured you can query your standard infra DNS directly and it should return the same
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* If edgeDNS was configured you can query your standard infra DNS directly and it should return the same
* If edgeDNS was configured, you can query your standard infra DNS directly and it should return the same

@ytsarev
Copy link
Member Author

ytsarev commented Oct 26, 2020

@kuritka cool stuff, thanks a ton for review

* Add the doc
* Add the sample reference terraform code
* Add the sample k8gb values yaml
* Additionally make some minor fix to values.yaml
@ytsarev ytsarev requested a review from kuritka October 26, 2020 12:02
@ytsarev ytsarev changed the title [WIP] Readme revamp Readme revamp and Route53 tutorial Oct 26, 2020
Copy link
Collaborator

@k0da k0da left a comment

Choose a reason for hiding this comment

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

LGTM

@ytsarev ytsarev merged commit dcadf67 into master Oct 26, 2020
@ytsarev ytsarev deleted the readme-revamp branch October 26, 2020 13:22
@ytsarev ytsarev mentioned this pull request Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants