Apache License 2.0 #20

bevacqua · 2017-10-24T12:49:53Z

We probably want at least a couple eyeballs on this PR. It's just text, but we need to make sure it doesn't sound "angry", frustrate any users or customers, etc.

nrichers

@bevacqua I looked at this purely from a text point of view and had only minor comments. I don't think I am the right person to approve this PR. Perhaps grab someone from the legal team for approval?

nrichers · 2017-10-24T12:57:13Z

LICENSE-FAQ.md

@@ -0,0 +1,25 @@
+# Frequently Asked Questions
+
+Here's our responses to questions we expect to get frequently.


"Here's" > "Here are" (responses is plural).

nrichers · 2017-10-24T13:00:02Z

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Elasticsearch BV


Copyright statements usually have to follow a very specific format. I think it's first year, current year plus possibly the copyright symbol, but I would check into what Elastic requires.

Mostly just copied what Kibana does at https://github.com/elastic/kibana/blob/88f3af406dcf95828b0297372f17d417d0d2915b/LICENSE.md

I figured Kibana is doing it right

I know of at least one case where two rescue crew ended up getting thrown off the boat at speed because they had been asked to hang onto something. They hung onto each other instead of the boat. :-)

nrichers · 2017-10-24T13:03:54Z

LICENSE-FAQ.md

+
+## What is it?
+
+Components and design directives for developing user interfaces that are on brand with Elastic.


I'd say "on brand" seems like marketing slang. Is there a better phrase you can use, like "... that reuse Elastic branding" or something like that?

What's wrong with marketing slang? 😅

nrichers · 2017-10-24T13:04:33Z

LICENSE-FAQ.md

+
+Yes, but it's discouraged unless you're developing a plugin for Elastic products, or too curious. We recommend you avoid consuming `eui` entirely.
+
+## Why is it open-source?


Global comment: use "open source" (no hyphen).

nrichers · 2017-10-24T13:06:17Z

LICENSE-FAQ.md

+
+## Can I use this?
+
+Yes, but it's discouraged unless you're developing a plugin for Elastic products, or too curious. We recommend you avoid consuming `eui` entirely.


There has to be someone this is aimed at? If so I would state that here, rather than phrasing this text wholly negatively. A similar comment goes for line 17ff.

EDIT: This is stated in README.md, but I would repeat the following info here: "The intended consumers of this repository are [other] Elastic products."

nrichers · 2017-10-24T13:09:08Z

README.md

 # Elastic UI Framework

 > The Elastic UI Framework is a collection of React UI components for quickly building user interfaces
 > at Elastic. Not using React? No problem! You can still use the CSS behind each component.

+You should check out our [living style guide][docs], which contains many examples on how components in the EUI framework look and feel, and how to use them in your products.
+
 # Installation



As a rule of thumb, commands should have a lead-in besides just a section heading. E.g. say "To install the Elastic UI Framework:".

pugnascotia

Generally looks fine, bar Nik's comments.

jordansissel · 2017-10-24T14:07:53Z

LICENSE-FAQ.md

@@ -0,0 +1,21 @@
+# Frequently Asked Questions


This file feels weird to be named "LICENSE FAQ" -- it only includes one question that is license-related and even this doesn't feel strongly suited to such a license-faq name.

Maybe put this in the README.md instead?

In general I prefer to discuss things like public interface in the README, although for a package like this which has such a large API surface, that'll probably belong on the documentation site.

I agree that the FAQ ended up not really being all that license related, what if we just renamed that file FAQ.md?

Sound good to me.

pugnascotia

LGTM

zinckiwi

LGTM besides purely subjective comment.

zinckiwi · 2017-10-24T19:46:26Z

FAQ.md

+
+Here are our responses to questions we expect to get frequently.
+
+## What is it?


I have a slight preference for expanding the pronouns to “Elasic UI Framework” or “EUI” in these headings.

snide

Added some clarity for the wording in the FAQ, making sure that stuff @epixa mentioned to me are in there. I have no commentary on whether the FAQ needs to live in the Readme or not. Some of the points there seem to be more general (like statements of purpose...etc).

snide · 2017-10-24T19:56:16Z

FAQ.md

+
+## What is it?
+
+Components and design directives for developing user interfaces that are on brand with Elastic.


The Elastic UI Framework (EUI) is a design library in use at Elastic to build internal products that need to share our branding and look and feel. It distributes UI React components and static assets for use in building web layouts. Alongside the React components is a Sass/CSS layer that can be used independently on its own.

snide · 2017-10-24T19:57:58Z

FAQ.md

+
+## Can I use this?
+
+The intended consumers of this repository are Elastic products. You could use it when developing plugins for Elastic products such as Kibana, or if you're really curious. Otherwise, we recommend you avoid consuming `eui` entirely.


The Elastic UI Framework is intended to only be used on Elastic products and is not supported as a discrete, independent design library. We do not recommend using it unless you are working on Elastic products or plugins to those products.

snide · 2017-10-24T20:09:45Z

FAQ.md

+
+## Why is it open source?
+
+For a number of reasons. This code started deep in the Kibana codebase long before it made it to a standalone repository. In a sense, it was already open source, just not a first-class citizen. Other products in Elastic need to take advantage of these components, but that was hard to accomplish if the components continued to be a part of Kibana. Given Kibana is open source, this package needs to be open source. This enables us to publish on `npm` more transparently, use versioning, and maintain [an up-to-date website][docs] showcasing the functionality.


Because many of our products themselves are open source and rely upon this library to function. The Elastic UI Framework began as a folder of code in Kibana and we decided it could be used beyond that codebase. It exists as an independent library so that patterns can be shared across teams and design standards can be scaled across our organization. Since most of our products are open source, we treat this one similarly as far as public publishing and conversation even if its usage tends to focus more inward towards Elastic itself.

bevacqua · 2017-10-24T20:22:33Z

@snide Your prose was great, I've switched those sections over to what you wrote

cjcenizal

Nice work! LGTM once legal has approved the license as it's written.

snide

I can put together a more formal readme, but what's added in this PR seems OK to me.

bevacqua · 2017-10-24T20:50:30Z

Baby steps.

Add popovers section to examples

bevacqua requested review from snide, cjcenizal, pugnascotia and nrichers October 24, 2017 12:49

bevacqua mentioned this pull request Oct 24, 2017

Open-source #22

Closed

3 tasks

nrichers reviewed Oct 24, 2017

View reviewed changes

pugnascotia previously approved these changes Oct 24, 2017

View reviewed changes

jordansissel reviewed Oct 24, 2017

View reviewed changes

bevacqua dismissed pugnascotia’s stale review via 41199ea October 24, 2017 14:23

pugnascotia previously approved these changes Oct 24, 2017

View reviewed changes

zinckiwi previously approved these changes Oct 24, 2017

View reviewed changes

snide reviewed Oct 24, 2017

View reviewed changes

bevacqua added 4 commits October 24, 2017 17:19

Apache license 2.0

01380c4

Follow @nrichers comments on prose

155a7fe

Move FAQ

7fc8ebf

Update prose using @snide recommendations

7ed9135

bevacqua dismissed stale reviews from zinckiwi and pugnascotia via 7ed9135 October 24, 2017 20:21

bevacqua force-pushed the licensing branch from 41199ea to 7ed9135 Compare October 24, 2017 20:21

cjcenizal approved these changes Oct 24, 2017

View reviewed changes

snide approved these changes Oct 24, 2017

View reviewed changes

bevacqua merged commit 9584c85 into master Oct 24, 2017

bevacqua deleted the licensing branch October 26, 2017 17:51

lcawl pushed a commit to lcawl/eui that referenced this pull request Aug 31, 2021

Merge pull request elastic#20 from lcawl/popovers

b52293f

Add popovers section to examples

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apache License 2.0 #20

Apache License 2.0 #20

bevacqua commented Oct 24, 2017

nrichers left a comment

nrichers Oct 24, 2017

nrichers Oct 24, 2017

bevacqua Oct 24, 2017

nrichers Oct 24, 2017

nrichers Oct 24, 2017

bevacqua Oct 24, 2017

nrichers Oct 24, 2017

nrichers Oct 24, 2017

nrichers Oct 24, 2017

pugnascotia left a comment

jordansissel Oct 24, 2017

bevacqua Oct 24, 2017

pugnascotia Oct 24, 2017

pugnascotia left a comment

zinckiwi left a comment

zinckiwi Oct 24, 2017

snide left a comment

snide Oct 24, 2017

snide Oct 24, 2017

snide Oct 24, 2017

bevacqua commented Oct 24, 2017

cjcenizal left a comment

snide left a comment

bevacqua commented Oct 24, 2017

		@@ -0,0 +1,25 @@
		# Frequently Asked Questions

		Here's our responses to questions we expect to get frequently.


		## What is it?

		Components and design directives for developing user interfaces that are on brand with Elastic.


		Yes, but it's discouraged unless you're developing a plugin for Elastic products, or too curious. We recommend you avoid consuming `eui` entirely.

		## Why is it open-source?


		## Can I use this?

		Yes, but it's discouraged unless you're developing a plugin for Elastic products, or too curious. We recommend you avoid consuming `eui` entirely.


		Here are our responses to questions we expect to get frequently.

		## What is it?


		## Can I use this?

		The intended consumers of this repository are Elastic products. You could use it when developing plugins for Elastic products such as Kibana, or if you're really curious. Otherwise, we recommend you avoid consuming `eui` entirely.


		## Why is it open source?

		For a number of reasons. This code started deep in the Kibana codebase long before it made it to a standalone repository. In a sense, it was already open source, just not a first-class citizen. Other products in Elastic need to take advantage of these components, but that was hard to accomplish if the components continued to be a part of Kibana. Given Kibana is open source, this package needs to be open source. This enables us to publish on `npm` more transparently, use versioning, and maintain [an up-to-date website][docs] showcasing the functionality.

Apache License 2.0 #20

Apache License 2.0 #20

Conversation

bevacqua commented Oct 24, 2017

nrichers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pugnascotia left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pugnascotia left a comment

Choose a reason for hiding this comment

zinckiwi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snide left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bevacqua commented Oct 24, 2017

cjcenizal left a comment

Choose a reason for hiding this comment

snide left a comment

Choose a reason for hiding this comment

bevacqua commented Oct 24, 2017