-
Notifications
You must be signed in to change notification settings - Fork 73
v13: add info about communities #789
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
base: master
Are you sure you want to change the base?
v13: add info about communities #789
Conversation
6f67856
to
708c76e
Compare
708c76e
to
7c0299f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Since kind of dependent/related to #795, probably best to get that one in first.
### Collections | ||
### Communities | ||
|
||
#### Themed communities |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the feature name we want to converge on: "Branded communities" per #795 or "Themed communities"?
Once the other PR is merged, we should add a link to its relevant page(s).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not decided yet tbh, so something we can discuss here.
"Themed Communities"
- Pros
- Matches how we refer to the feature in code
- Is "technically" more correct
- Doesn't sound commercial or marketing-heavy
- Cons
- A bit ambiguous, we also have a "Theming" section
- Too "basic"? Kind of trivializes what you can do with it
"Branded Communities"
- Pros
- Has a bit more "gravitas" as a term, i.e. you can imprint some identity to a community by "branding" it
- Cons
- Sounds marketing-focused
- Maybe a bit "scary" as to what the implications are (which are not that big, you just add some colors, and possibly override templating)
Personally, I prefer "Themed communities". It's a more advanced feature (you need to know about color codes and potentially Jinja templates), and instance managers/sysadmins would probably "get it" more easily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, eh 🤔 ? Put like that, "themed communities" sounds a little better. I even see it as a pro that it can echo the "theming" notion since it's essentially what we are doing with that feature, but at a community level. Although I am perhaps thinking more of this theme section. For what it's worth I've asked colleagues (no response yet though).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok some other recommendations have trickled in from colleagues:
- Bespoke communities (admitted to be too highfalutin by suggester)
- Customized communities
- Tailored communities (a couple liked this one)
docs/releases/v13/version-v13.0.0.md
Outdated
|
||
!!! note | ||
|
||
Currently communities can only have one level of heirarchy (i.e., no grand-child communities) and communities can only have one parent community. The former restriction would be more easily overridden in your instance if required. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently communities can only have one level of heirarchy (i.e., no grand-child communities) and communities can only have one parent community. The former restriction would be more easily overridden in your instance if required. | |
Currently communities can only have one level of hierarchy (i.e., no grand-child communities) and communities can only have one parent community. The former restriction would be more easily overridden in your instance if required. |
Also "would be more easily overridden" as in "it can easily be overridden in your instance"? Or, in the future we will make it overridable on a per instance basis? If former, probably best to word it as such.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is "easily overridden" but need confirmation from @slint
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Via the programmatic API, one can infinitely nest communities; however, it has been decided that we don't want to officially support this, as it greatly complicates permissions (for both developers and end-users to understand).
Right now, we have the following building blocks for nesting content:
- Communities
- Sub-communities
- Collections Trees
- Collections (at this point infinitely nestable actually, but just for organizing content browsing/discovery, and not access/permissions)
- Collections Trees
- Sub-communities
So I wouldn't mention anything about overriding here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So something like:
Option 1: no mention of overriding at all
"Currently communities can only have one level of hierarchy (i.e., no grand-child communities) and communities can only have one parent community.
OR
Option 2: just reword the 'more easily overridden part'
"Currently communities can only have one level of hierarchy (i.e., no grand-child communities) and communities can only have one parent community. The former restriction can be overridden in your instance if required."
OR
Option 3: explain the situation
Currently communities can only have one level of hierarchy (i.e., no grand-child communities) and communities can only have one parent community. The former restriction can be overridden via the programmatic API in your instance, but it has been decided to not officially support this in stock InvenioRDM as it greatly complicates permissions for end-users and implementers.
`
Co-authored-by: Guillaume Viger <fenekku@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just last clarification on blurb, but otherwise all good to merge.
❤️ Thank you for your contribution!
Description
Checklist
Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:
master
branch.production
branch following approval or indicate to a maintainer that it should be backported.Reminder
By using GitHub, you have already agreed to the GitHub’s Terms of Service including that: