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

Delegate the responsibility of rendering stream descriptions to the backend #11272

Closed
7 tasks done
Hypro999 opened this issue Jan 14, 2019 · 10 comments
Closed
7 tasks done

Comments

@Hypro999
Copy link
Member

Hypro999 commented Jan 14, 2019

Currently, the rendering of streams' descriptions is handled by the frontend. However, this could cause time-related issues, particularly for the mobile clients. Hence by moving this responsibility to the backend and then storing the results of the rendering, we could save on a lot time and avoid a lot of unnecessary processing.

The general steps to be taken on the backend side are:

  • Update the Stream model accordingly.
  • Modify the data migration that runs when we first deploy the feature.
  • Update the functions that edit a stream's description.
  • Update the function that creates a stream.
  • Update any other parts of the code that look at description to consider the rendered description as well.

After this the frontend can be modified accordingly:

  • Update all display code
  • Update the stream description edit UI to use the backend renderings.
@hackerkid
Copy link
Member

@zulipbot label "area: stream settings"

@zulipbot
Copy link
Member

Hello @zulip/server-streams members, this issue was labeled with the "area: stream settings" label, so you may want to check it out!

@Hypro999
Copy link
Member Author

@zulipbot claim

@zulipbot
Copy link
Member

Hello @Hypro999!

Thanks for your interest in Zulip! You have attempted to claim an issue without the labels "help wanted", "good first issue". Since you're a new contributor, you can only claim and submit pull requests for issues with the help wanted or good first issue labels.

If this is your first time here, we recommend reading our guide for new contributors before getting started.

@hackerkid
Copy link
Member

@zulipbot label "help wanted"

@Hypro999
Copy link
Member Author

@zulipbot claim

@zulipbot
Copy link
Member

Welcome to Zulip, @Hypro999! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

@zulipbot
Copy link
Member

zulipbot commented Jan 25, 2019

Hello @Hypro999, you have been unassigned from this issue because you have not updated this issue or any referenced pull requests for over 14 days.

You can reclaim this issue or claim any other issue by commenting @zulipbot claim on that issue.

Thanks for your contributions, and hope to see you again soon!

@Hypro999
Copy link
Member Author

I'm still working on this issue. I have talked with @timabbott about some other urgent work that has popped up so I have had to suspend my progress on this issue. However, I think that it would be better if I finished PR #11284 soon and then maybe work on the frontend aspects after my urgent task. So I will.

@Hypro999
Copy link
Member Author

Done with the backend portion.

vrongmeal pushed a commit to vrongmeal/zulip that referenced this issue Feb 13, 2019
On clicking the edit button for a stream description, the stream's
unrendered description should be made editable as text instead of
the stream's rendered description (which would be displayed as HTML
instead of text).

This completes the effort to use backend-rendered stream descriptions
here.  Fixes zulip#11272.
ruchit2801 pushed a commit to ruchit2801/zulip that referenced this issue Feb 13, 2019
On clicking the edit button for a stream description, the stream's
unrendered description should be made editable as text instead of
the stream's rendered description (which would be displayed as HTML
instead of text).

This completes the effort to use backend-rendered stream descriptions
here.  Fixes zulip#11272.
ericgumba pushed a commit to ericgumba/zulip that referenced this issue Mar 2, 2019
On clicking the edit button for a stream description, the stream's
unrendered description should be made editable as text instead of
the stream's rendered description (which would be displayed as HTML
instead of text).

This completes the effort to use backend-rendered stream descriptions
here.  Fixes zulip#11272.
Nikhil-Vats pushed a commit to Nikhil-Vats/zulip that referenced this issue Mar 17, 2019
On clicking the edit button for a stream description, the stream's
unrendered description should be made editable as text instead of
the stream's rendered description (which would be displayed as HTML
instead of text).

This completes the effort to use backend-rendered stream descriptions
here.  Fixes zulip#11272.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants