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

Improve the high-level descriptions around the 2i2c Hub service #314

Closed
choldgraf opened this issue Mar 19, 2021 · 3 comments
Closed

Improve the high-level descriptions around the 2i2c Hub service #314

choldgraf opened this issue Mar 19, 2021 · 3 comments
Labels
Enhancement An improvement to something or creating something new.

Comments

@choldgraf
Copy link
Member

Background

There are two major places where we introduce and discuss the 2i2c Hub Service pilot:

We should take a pass at both of them to make sure that we are discussing and highlighting aspects of our Hub Service that we wish. For example, here are a few things that I think we should improve:

  • on 2i2c.org, the things we discuss don't quite match the services that we offer
  • explain more the pilot project in general at an organizational level
  • standardize on terminology for the pilot (is it a 2i2c Hub, a 2i2c Hub service, etc)
  • update expectations around the Managed Service Plan, and link to it when we feel ready to do so
  • Improve the "overview" section that describes what a 2i2c Hub is
  • Explain more our justification for why we use the technology stack that we do, and why this is the right stack for others to use
  • More generally, have a strategy for what information is on 2i2c.org, and what is on pilot.2i2c.org, and how will people flow between them

Expected timeline

We should make iterative improvements to the documentation over the next several months, but should plan on a "deep dive" on the docs after we've had a moment for others to use the docs, run through a few customers, etc.

Steps to complete this goal

The main thing we should do to complete this goal is have a deep dive on the docs as a group of one or more people, and make updates until we are satisfied with the "next iteration" of describing the hub services. We should also run the docs by a few others to get their feedback.

yuvipanda added a commit to yuvipanda/2i2c-org.github.io that referenced this issue Mar 21, 2021
2i2c-org/infrastructure#314 talks
about the need to be very explicit in what we call the
service we provide. The word 'hub' is very overloaded.

2i2c managed infrastructure has an important property that our naming
should reflect.  It isn't a *new thing* we are developing, but a
deployment of an upstream, purely open source product. This means
our users can always:

1. Take their infrastructure from 2i2c, and run it themselves
   with help from the community.
2. Work with us to *train* their own staff to run their JupyterHub,
   so they can participate fully in running the infrastructure. This
   gives them organizational control over what is built, and they
   can walk away easier if needed.
3. Any improvements we make in terms of features built or
   operations smoothed will be made in upstream repositories, and

I think directly using the word JupyterHub is a good way to
communicate this.

Alternative suggestions:

1. just 'JupyterHub'
2. 2i2c JupyterHub
3. JupyterHub managed by 2i2c

I prefer (2) if needed.

Question is, how does this related to the Jupyter Trademark
policy (https://jupyter.org/governance/trademarks.html)?
Particularly:

> Any commercial use of the Jupyter trademarks in product or company
> names must be approved first by Project Jupyter. Some uses, like calling
> a company “The Jupyter Company,” or a product “Jupyter Hosting” or
> “Jupyter Cloud” will be refused. This is because they are overly broad,
> or confusing as to whether Jupyter is open source or commercial, or
> whether your product or organization is affiliated with or sponsored by
> Project Jupyter.

(from
https://jupyter.org/governance/trademarks.html#uses-that-always-require-approval)

So no matter what, I think this needs to go to the Jupyter steering
council. I personally believe that '2i2c managed JupyterHub' is fine,
but that's not for me to decide.
@yuvipanda
Copy link
Member

I opened 2i2c-org/2i2c-org.github.io#42 to discuss nomenclature of what we offer.

yuvipanda added a commit to yuvipanda/2i2c-org.github.io that referenced this issue Mar 21, 2021
2i2c-org/infrastructure#314 talks
about the need to be very explicit in what we call the
service we provide. The word 'hub' is very overloaded.

2i2c managed infrastructure has an important property that our naming
should reflect.  It isn't a *new thing* we are developing, but a
deployment of an upstream, purely open source product. This means
our users can always:

1. Take their infrastructure from 2i2c, and run it themselves
   with help from the community.
2. Work with us to *train* their own staff to run their JupyterHub,
   so they can participate fully in running the infrastructure. This
   gives them organizational control over what is built, and they
   can walk away easier if needed.
3. Any improvements we make in terms of features built or
   operations smoothed will be made in upstream repositories, and

I think directly using the word JupyterHub is a good way to
communicate this.

Alternative suggestions:

1. just 'JupyterHub'
2. 2i2c JupyterHub
3. JupyterHub managed by 2i2c

I prefer (2) if needed.

Question is, how does this related to the Jupyter Trademark
policy (https://jupyter.org/governance/trademarks.html)?
Particularly:

> Any commercial use of the Jupyter trademarks in product or company
> names must be approved first by Project Jupyter. Some uses, like calling
> a company “The Jupyter Company,” or a product “Jupyter Hosting” or
> “Jupyter Cloud” will be refused. This is because they are overly broad,
> or confusing as to whether Jupyter is open source or commercial, or
> whether your product or organization is affiliated with or sponsored by
> Project Jupyter.

(from
https://jupyter.org/governance/trademarks.html#uses-that-always-require-approval)

So no matter what, I think this needs to go to the Jupyter steering
council. I personally believe that '2i2c managed JupyterHub' is fine,
but that's not for me to decide.
@yuvipanda
Copy link
Member

More generally, have a strategy for what information is on 2i2c.org, and what is on pilot.2i2c.org, and how will people flow between them

I wrote about this a little bit in our page on documentation structure. I see the following structure:

  1. Website - for people who are trying to understan what 2i2c does, and see if it is interesting to them.
  2. Pilot docs - for people who are already using our managed JupyterHubs, and need to figure out how to accomplish things they want to do. This could also be used by people in advanced stages of evaluating us.
  3. Pilot hubs docs - for 2i2c operators, and others in the open source community who can benefit from this.

How does that sound?

choldgraf added a commit to 2i2c-org/2i2c-org.github.io that referenced this issue Mar 25, 2021
* Call them 2i2c managed JupyterHubs rather than hubs

2i2c-org/infrastructure#314 talks
about the need to be very explicit in what we call the
service we provide. The word 'hub' is very overloaded.

2i2c managed infrastructure has an important property that our naming
should reflect.  It isn't a *new thing* we are developing, but a
deployment of an upstream, purely open source product. This means
our users can always:

1. Take their infrastructure from 2i2c, and run it themselves
   with help from the community.
2. Work with us to *train* their own staff to run their JupyterHub,
   so they can participate fully in running the infrastructure. This
   gives them organizational control over what is built, and they
   can walk away easier if needed.
3. Any improvements we make in terms of features built or
   operations smoothed will be made in upstream repositories, and

I think directly using the word JupyterHub is a good way to
communicate this.

Alternative suggestions:

1. just 'JupyterHub'
2. 2i2c JupyterHub
3. JupyterHub managed by 2i2c

I prefer (2) if needed.

Question is, how does this related to the Jupyter Trademark
policy (https://jupyter.org/governance/trademarks.html)?
Particularly:

> Any commercial use of the Jupyter trademarks in product or company
> names must be approved first by Project Jupyter. Some uses, like calling
> a company “The Jupyter Company,” or a product “Jupyter Hosting” or
> “Jupyter Cloud” will be refused. This is because they are overly broad,
> or confusing as to whether Jupyter is open source or commercial, or
> whether your product or organization is affiliated with or sponsored by
> Project Jupyter.

(from
https://jupyter.org/governance/trademarks.html#uses-that-always-require-approval)

So no matter what, I think this needs to go to the Jupyter steering
council. I personally believe that '2i2c managed JupyterHub' is fine,
but that's not for me to decide.

* Reword the 'features' page

- Remove 'distributing content', add 'authentication' instead
- Trim content size

* Re-title infra intro section

* Shorten menu item name

* Consistency fix

* Minor grammatical fix

Co-authored-by: Chris Holdgraf <[email protected]>
@choldgraf choldgraf added Enhancement An improvement to something or creating something new. and removed type: goal labels Apr 15, 2021
@yuvipanda
Copy link
Member

I think there's other useful tickets tracking this more specifically.

brwsioeb added a commit to brwsioeb/2i2c-org.github.io that referenced this issue Aug 14, 2024
* Call them 2i2c managed JupyterHubs rather than hubs

2i2c-org/infrastructure#314 talks
about the need to be very explicit in what we call the
service we provide. The word 'hub' is very overloaded.

2i2c managed infrastructure has an important property that our naming
should reflect.  It isn't a *new thing* we are developing, but a
deployment of an upstream, purely open source product. This means
our users can always:

1. Take their infrastructure from 2i2c, and run it themselves
   with help from the community.
2. Work with us to *train* their own staff to run their JupyterHub,
   so they can participate fully in running the infrastructure. This
   gives them organizational control over what is built, and they
   can walk away easier if needed.
3. Any improvements we make in terms of features built or
   operations smoothed will be made in upstream repositories, and

I think directly using the word JupyterHub is a good way to
communicate this.

Alternative suggestions:

1. just 'JupyterHub'
2. 2i2c JupyterHub
3. JupyterHub managed by 2i2c

I prefer (2) if needed.

Question is, how does this related to the Jupyter Trademark
policy (https://jupyter.org/governance/trademarks.html)?
Particularly:

> Any commercial use of the Jupyter trademarks in product or company
> names must be approved first by Project Jupyter. Some uses, like calling
> a company “The Jupyter Company,” or a product “Jupyter Hosting” or
> “Jupyter Cloud” will be refused. This is because they are overly broad,
> or confusing as to whether Jupyter is open source or commercial, or
> whether your product or organization is affiliated with or sponsored by
> Project Jupyter.

(from
https://jupyter.org/governance/trademarks.html#uses-that-always-require-approval)

So no matter what, I think this needs to go to the Jupyter steering
council. I personally believe that '2i2c managed JupyterHub' is fine,
but that's not for me to decide.

* Reword the 'features' page

- Remove 'distributing content', add 'authentication' instead
- Trim content size

* Re-title infra intro section

* Shorten menu item name

* Consistency fix

* Minor grammatical fix

Co-authored-by: Chris Holdgraf <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement An improvement to something or creating something new.
Projects
None yet
Development

No branches or pull requests

2 participants