remotestorage / remotestorage.io

[DEPRECATED] Old RS website
50 stars 30 forks source link

remoteStorage, RemoteStorage, remotestorage, remote storage, Remote Storage, or what? #23

Closed raucao closed 11 years ago

raucao commented 11 years ago

I just saw that the latest IETF spec breaks with the old W3C wiki one in regards to the precise naming and uses "remotestorage". As this is an important question for presentation and usage, and it seems to have silently changed and, more importantly, be used differently by different people and in different contexts, we should have a proper discussion and decisions on how exactly the term is written and used in all contexts.

I think "remotestorage" looks very wrong in almost all situations, but especially in ones, where you want to refer to the actual storage instead of the protocol or library (e.g. "connect your storage". I vote for that case to just use "remote storage". I don't think it will be an issue with other products, because you'd then normally use the product name (or other open standard name) instead of this seemingly generic term.

In regards to the protocol and libraries, it seems to me that it makes more sense to use the lower camelCase version, as this not only reflects the localStorage standard, but also divides the word visibly. Which looks much less wrong to my eyes, because in English you usually don't have composed words without separative characters.

Like any word, it should always be possible to use it in all caps for logos etc. (and in the current logo it is set in 2 lines, also making it "REMOTE STORAGE" by the way).

michielbdejong commented 11 years ago

so then i would call the npm package remotestorage-client to emphasize it's a (server-side) client, which is the unexpected aspect there. emphasizing that it is written in javascript by adding 'js' to an npm module is futile.

jancborchardt commented 11 years ago

Calling the package anything else than »remotestorage« just seems like we didn’t get that name. Since remotestorage.js is the way to add remotestorage support to your app, it’s like »just add remotestorage«.

Would there ever be a »remotestorage« npm package? If so, what would it be? And yeah, the ».js« is just superfluous.

On Thu, Feb 7, 2013 at 7:36 PM, Michiel@unhosted notifications@github.comwrote:

so then i would call the npm package remotestorage-client to emphasize it's a (server-side) client, which is the unexpected aspect there. emphasizing that it is written in javascript by adding 'js' to an npm module is futile.

— Reply to this email directly or view it on GitHubhttps://github.com/RemoteStorage/remotestorage.io/issues/23#issuecomment-13252173.

raucao commented 11 years ago

Since remotestorage.js is the way to add remotestorage support to your app, it’s like »just add remotestorage«.

You might add remotestorage to your server as well. And node.js is used more for server-side stuff than client-side libs. It'd be clear with Bower or Component that it's a client-side lib, but not for an npm module.

xMartin commented 11 years ago

Thanks for waiting :) I believe things like that need some time and in a way it is rocket science. Naming shit is hard. It is important to us because a name is the first thing people will see of our beloved product that we all put so much effort and passion in. Also we don't want to make ourselves look like fools not sticking to the conventions or even rules about names in all these environments we are advancing. And the worst: there's personal taste and current trends.

I thought about this for some time and then went to the IRC channel to get some inspiration. It helped. So here is my proposal:

It is one word. No space. We write it like so "remoteStorage" because a) we like it, b) we can, c) it is a reference to localStorage (although this may not be technically correct for all times this is how it started and it's ok), d) it looks good and the capital S makes it easy to read. We write it like that everywhere except a) we can only use lower case (it's "remotestorage" then), b) the spec uses lower case but this is deprecated[1], c) the logo is all upper case but this is deprecated[2].

No-one keeps you from using the words "remote" and "storage" when explaining something, but the project and product are called "remoteStorage". The website has it right already, the widget has to be adjusted.

Now what would that mean in concrete changes:

This is my proposal. As you seem to have been waiting for me I ask everybody being active so far in this discussion to give a final opinion/feedback. If we basically agree we can then open new issues for each topic (be it doing actual changes or discussing further).

[1] If there will ever be a chance, rename "remotestorage" in the spec to "remoteStorage". Otherwise we will live with it.

[2] Hold on! I'm not saying we're changing the logo! The logo is great! And it's all upper case so it's not wrong. I'm just saying if we make a major redesign it would be good to reflect the spelling "remoteStorage".

michielbdejong commented 11 years ago

@xMartin wrote:

I think @skddc has it right with filenames, repos, urls. Change them to lower case.

ok, i just checked how jQuery does it, and they also do this, so makes sense. anyway, we now have three proposals:

in all cases the current logo is all-caps and we don't worry too much about that, because it's a great logo.

i'm ok with names-vs-urls, especially since i saw that this is also exactly how jQuery do it (who have the same problem and obviously have some power as a precedent). if this is the option we choose, then we can easily change this in the remotestorage-01 spec, which comes out in June. it actually feels more consistent than the "mixed" option, i think

jancborchardt commented 11 years ago

I fully sign @xMartin’s post. If that’s what you mean with »names-vs-urls«, @michielbdejong, then that would be the proposal of choice, although I think Martin’s post is more of a conclusion of the discussion after having talked to everyone, rather than a third proposal.

So does anyone have objections to what Martin said above? @nilclass @skddc @silverbucket

silverbucket commented 11 years ago

all good for me!

On Sat, Feb 9, 2013 at 6:19 PM, Jan-Christoph Borchardt < notifications@github.com> wrote:

I fully sign @xMartin https://github.com/xMartin’s post. If that’s what you mean with »names-vs-urls«, @michielbdejonghttps://github.com/michielbdejong, then that would be the proposal of choice, although I think Martin’s post is more of a conclusion of the discussion after having talked to everyone, rather than a third proposal.

So does anyone have objections to what Martin said above? @nilclasshttps://github.com/nilclass @skddc https://github.com/skddc @silverbuckethttps://github.com/silverbucket

— Reply to this email directly or view it on GitHubhttps://github.com/RemoteStorage/remotestorage.io/issues/23#issuecomment-13334487..

michielbdejong commented 11 years ago

cool! as it looks like there are no objections to @xMartin's proposal, i updated this in https://github.com/RemoteStorage/spec/commit/4e907b56533e6976fc3480420859c698c1f5a26b and https://github.com/unhosted/website/commit/918ce15f9d17de5691a7eb057ce95eef4f07a810

@nilclass do you want to conduct the honors of renaming the org, the repo, and the names of the (built) files?

xMartin commented 11 years ago

As I said I'd prefer to have separate issues for the actions to take so we can write down in detail what should be done.

Additionally, also as I said, I'd like to wait until everybody that took part in the discussion gave a feedback.

Renaming things might need some more communication like writing to the list and so on. If we want to be more serious about this project, "getting shit done" is not the only thing that matters. Not annoying users too much would be a thing, for instance.

michielbdejong commented 11 years ago

ok, do it. open issues. write to mailing lists.

michielbdejong commented 11 years ago

As I said I'd prefer to have separate issues for the actions to take so we can write down in detail what should be done.

Done, see https://github.com/RemoteStorage/remoteStorage.js/issues/280

Additionally, also as I said, I'd like to wait until everybody that took part in the discussion gave a feedback.

Done, see current ticket.

Renaming things might need some more communication like writing to the list and so on.

Done, see https://groups.google.com/forum/#!topic/unhosted/vacqrNYSHN8

Thank you all for your patience! :)