From 8d54b3a0e5892fe2958bad01765f47f574b8604c Mon Sep 17 00:00:00 2001 From: troshko111 <931973+troshko111@users.noreply.github.com> Date: Thu, 12 Aug 2021 11:25:44 -0700 Subject: [PATCH] Update README - Clarify contributing and support guidelines - Make the description more concise --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index dd7a967f54..1280fb4ebd 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,24 @@ Eureka -===== +====== [![Build Status](https://travis-ci.com/Netflix/eureka.svg?branch=master)](https://travis-ci.com/Netflix/eureka) -Eureka is a REST (Representational State Transfer) based service that is primarily used in the AWS cloud for locating services for the purpose of load balancing and failover of middle-tier servers. - -At Netflix, Eureka is used for the following purposes apart from playing a critical part in mid-tier load balancing. - -* For aiding Netflix Asgard - an open source service which makes cloud deployments easier, in - + Fast rollback of versions in case of problems avoiding the re-launch of 100's of instances which - could take a long time. - + In rolling pushes, for avoiding propagation of a new version to all instances in case of problems. - -* For our cassandra deployments to take instances out of traffic for maintenance. - -* For our memcached caching services to identify the list of nodes in the ring. - -* For carrying other additional application specific metadata about services for various other reasons. - +Eureka is a RESTful (Representational State Transfer) service that is primarily used in the AWS cloud for the purpose of +discovery, load balancing and failover of middle-tier servers. It plays a critical role in Netflix mid-tier infra. Building ----------- -The build requires `java8` because of some required libraries that are `java8` (`servo`), but the source and target compatibility are still set to `1.7`. -Note that tags should be checked out to perform a build. +-------- +The build requires `java8` because of some required libraries that are `java8` (`servo`), but the source and target +compatibility are still set to `1.7`. Note that tags should be checked out to perform a build. +Contributing +------------ +For any non-trivial change (or a large LoC-wise change), please open an issue first to make sure there's alignment on +the scope, the approach, and the viability. Support ---------- -[Eureka Google Group](https://groups.google.com/forum/?fromgroups#!forum/eureka_netflix) +Community-driven mostly, feel free to open an issue with your question, the maintainers are looking over these +periodically. Issues with the most minimal repro possible have the highest chance of being answered. Documentation