[ENH] - Clarify the purpose and access to the examples folder

Context

When explaining access to the shared folder to new users, I say something like:

“The shared folder contains subfolders, one for each user group. Each user can only see and access the subfolder for the user group(s) that they are in.”

but then… there is this shared/examples folder.

“The examples folder isn’t a user group, it just has examples. But no one (?) can add or take away from it, it’s just there.”

That story feels off.

I propose a few options to help smooth this over.

• The examples folder could be a read-only folder that everyone sees off of root (similar to shared).
• The examples folder could be renamed to something explicit like: examples-READONLY
• The examples folder (and the shared folder for that matter) could contain a README.txt file explaining its purpose and the fact that its read only. (I’d suggest doing this as an absolute minimum)

Value and/or benefit

Less confused users.

Anything else?

No response

[trallard]

Stepping back - what is the purpose or added value of adding these examples on every nebari instance and thus for all users? Is the existence of said examples necessary for anyone to use nebari or any of its components at all? - answer: no

The examples in shared/examples are all pretty basic (“hello world” style) examples. And IMHO they are not essential to have there to start with - I would prefer having all the tutorial-like materials either in our docs or in repositories like nebari-demo. This will result in a better user experience and help us with maintainability instead of having multiple places where examples/tutorials/intro live and need to be updated.

The examples folder could be a read-only folder that everyone sees off of root (similar to shared).

In my opinion, this would make for a terrible user experience. As a platform user, unless there is anything critical to nebari itself and/or that would cause major problems if I delete it, I do not want a random folder with things in it in my day-to-day platform. We’d be forcing anyone on nebari to keep around low-value examples to avoid confusion around something where our implementation was a tad flaky (in the sense that this folder does not fit our permissions model, but it is just there 🤷🏽)

[kcpevey]

And to be clear, I’m thinking about providing our tutorials as notebooks (which we can link to at the end of each docs page). This creates maintenance burden, but it would streamline things for users.