realm: Add option to list realms publicly. #16073
Conversation
zerver/lib/home.py
Outdated
| if realm.oss_showcase == 1: | ||
| page_params["oss_showcase"] = True | ||
| else: | ||
| page_params["oss_showcase"] = False |
There was a problem hiding this comment.
I think this could go in zerver/lib/events.py instead.
zproject/prod_settings_template.py
Outdated
| # | ||
| # To avoid spam currently only sponsored realms can list their | ||
| # realms publicly. | ||
| OSS_SHOWCASE = False |
There was a problem hiding this comment.
We don't want to document this setting here; instead document it in zproject/default_settings.py
Since we don't expect it to be useful to self-hosted systems.
| label=admin_settings_label.realm_oss_showcase}} | ||
| </div> | ||
| </div> | ||
| {{/if}} |
There was a problem hiding this comment.
Let's make this a dropdown to match the data model. There's a chance we'll add additional values in the future that controls details like "How does the organization get listed?".
|
@pragatiagrawal31 @shubhamdhama @ryanreh99 do any of you have time to help debug the frontend for this? @majordwarf was asking for help with it. |
|
I can, but I don't get where exactly does he need help? @majordwarf can you explain? DM the chat link or let me know here. |
|
@pragatiagrawal31 I'll ping you on CZO. |
zerver/lib/home.py
Outdated
| if settings.OSS_SHOWCASE: | ||
| realm = user_profile.realm | ||
| page_params["plan_type"] = realm.get_plan_type | ||
| if realm.oss_showcase == 1: | ||
| page_params["current_oss_showcase_value"] = "hidden" | ||
| else: | ||
| page_params["current_oss_showcase_value"] = "visible" |
There was a problem hiding this comment.
The issue is with this block of code.
I think at most places we don't this type of conversion, although recently there are some settings that use this "string" value approach for APIs. But I don't think that fits here. You can remove this complete block and directly use page_params.realm_oss_showcase_policy on the frontend side. And follow as we do for other similar settings like email_address_visibility_values.
static/js/settings_config.js
Outdated
| text: i18n.t("Yes"), | ||
| }, | ||
| ], | ||
| ]); |
There was a problem hiding this comment.
If you follow my previous comment then you have to change this value map too, make it something like email_address_visibility_values
There was a problem hiding this comment.
So what's happening right now, if you update any setting, it doesn't update the corresponding page_params.current_oss_showcase_value for which you have to make changes in events.py. But why do this, if we have an automatic system, where page_params.realm_oss_showcase_policy is already being sent initially and is cared properly later on when there is any update.
|
@majordwarf As this PR was not linked with #15844, I started working on this as well and opened #16193. The UI and the backend are working fine. You can cherry-pick my commits and proceed ahead on creating '/public-communities' page. |
majordwarf
changed the title
|
@timabbott The PR is done currently working on fronted. |
The following commit adds a feature to allow sponsored realms to be listed publicly. This is done by adding a field in Realm model and toggle it via front-end. The feature will disabled by default for the production, it can be enabled by editing value of `OSS_SHOWCASE` in `defualt_settings.py`. Fixes: #15844.
| @@ -106,6 +109,13 @@ def update_realm( | |||
| video_chat_provider not in {p['id'] for p in Realm.VIDEO_CHAT_PROVIDERS.values()}): | |||
| return json_error(_("Invalid video_chat_provider {}").format(video_chat_provider)) | |||
|
|
|||
| realm_plan_type = realm.plan_type | |||
There was a problem hiding this comment.
This variable is unnecessary, we can go for realm.plan_type
| @@ -106,6 +109,13 @@ def update_realm( | |||
| video_chat_provider not in {p['id'] for p in Realm.VIDEO_CHAT_PROVIDERS.values()}): | |||
| return json_error(_("Invalid video_chat_provider {}").format(video_chat_provider)) | |||
|
|
|||
| realm_plan_type = realm.plan_type | |||
| if oss_showcase_policy is not None and realm_plan_type != 4: | |||
There was a problem hiding this comment.
Instead of hardcoding 4 we can use the variable Realm.STANDARD_FREE
| @@ -15,6 +15,10 @@ exports.reset = function () { | |||
| }; | |||
|
|
|||
| exports.maybe_disable_widgets = function () { | |||
| if (page_params.realm_plan_type !== 4) { | |||
There was a problem hiding this comment.
Here too, we can avoid hardcoding values, and put a constant in settings_config if there isn't one.
|
And since we have two PRs for the same issue, and have similar progress, @akashaviator would you be willing to give this PR a detailed review? |
|
Heads up @majordwarf, we just merged some commits that conflict with the changes your made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the |
|
Closing in favor of the rebased version #17021. @majordwarf if you want to get involved in helping with review there, that'd be very welcome! |
The following commit adds a feature to allow sponsored realms to be
listed publicly. This is done by adding a field in Realm model and
toggle it via front-end. The feature will disabled by default for the
production, it can be enabled by editing value of
OSS_SHOWCASEindefualt_settings.py.Fixes: #15844.