zoonk / deprecated-web Goto Github PK

Is your feature request related to a problem? Please describe.
When transitioning to the rich-text editor we ended up losing support for inlining code.

Describe the solution you'd like
We should add inline code support to the editor's toolbar.

Additional context
This kind of inline code isn't possible anymore:

Is your feature request related to a problem? Please describe.
When someone receives a notification, they need to visit Zoonk to see them.

Describe the solution you'd like
We should have an option to send email notifications.

Additional context
We should also have an option to unsubscribe to email notifications.

Tasks

• Add language field to notifications
• Add notification to the settings page
• Create Cloud Function for sending an email when a notification is created

Is your feature request related to a problem? Please describe.
It's hard to know when a topic I like has new posts or lessons.

Describe the solution you'd like
A new feature that allows users to follow topics.

Describe alternatives you've considered
N/A.

Additional context
This ticket should implement the following functionalities:

• Add a follow/unfollow button to the topic page
• Add a filter to the home page (all, following)
• The following tab is the default when users are logged in
• The all tab is the default when users are not logged in
• When a user is logged in and they're not following anyone, display a link to show all posts
• When a user isn't logged in and they click on following, then display the login form
• The following tab displays all posts from the topics a user follows
• When a user unfollows a topic, that topic's posts are removed from the timeline

Is your feature request related to a problem? Please describe.
It's very confusing to see what has changed in a post when going to the edit history.

Describe the solution you'd like
We should consider adopting a "split view" (before/after), similar to the one adopted by Wikipedia to see changes.

Additional context

Is your feature request related to a problem? Please describe.
Currently, zoonk allows user to add comments to a Question, starting a thread of discussion. The answer given by the user may get lost in the comments thread. There is no way, User can find out the suitable answer to his question.

Describe the solution you'd like
All questions asked should have the answer option with the comments, and Question owner can select the best answer thereby giving more visibility /credibility to the person who has answered the question. It would also lead to an increase in user engagement, as users can find answer to their question in a glimpse.

Additional context
Add any other context or screenshots about the feature request here.

Describe the bug
When I was creating a question on zoonk.org and tried to submit the question. It threw the
Function DocumentReference.set() called with invalid data. Unsupported field value: undefined (found in field createdBy.facebook)

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://en.zoonk.org/posts/add'

2. Fill in title, content and select topic

3. Scroll down and click on save.

4. See error

Expected behavior
The question should be submitted.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [Mac 10.15.4]
• Browser [ chrome Version 81.0.4044.138 (Official Build) (64-bit)]

Additional context
Add any other context about the problem here.

Is your feature request related to a problem? Please describe.
We get topics from Wikipedia pages. On Wikipedia, they have an option to redirect duplicated pages to existing ones keeping a default one when they have similar names (e.g. Remote work and remote working should be the same page).

Describe the solution you'd like
Add an option to automatically redirect a topic page to a different one. (E.g. "Remote working" could redirect to "Remote work").

Describe alternatives you've considered
N/A.

Additional context
When a post has a redirected topic, it should be replaced by the new one. For example, when a user adds a "Remote working" topic, it should be replaced by "Remote work" in the background.

This issue should be implemented after #35.

Is your feature request related to a problem? Please describe.
It's hard to see what contributions users made.

Describe the solution you'd like
We should display a list of posts users edited on their profile.

Additional context
We can query the editors field to do it:

db.collection("posts")
    .where("editors", "array-contains", userId)
    .orderBy("updatedAt", "desc")

Is your feature request related to a problem? Please describe.
Learning in traditional ways is boring, we need more interactive ways for learning - maybe something similar to what Duolingo does for learning a language.

Describe the solution you'd like
Every topic should have a quiz section where users can create different levels and we provide a guided, interactive learning path. Those quizzes should also provide some context: focus on real-life problems rather than just memorizing information.

Describe alternatives you've considered
We've experimented with new formats (e.g. interactive stories) in the past but they were overcomplicated for creating and playing. We should stick to something simpler for now and evolve with time.

Additional context
It's important that our quizzes focus on practical examples. It should also be easy to create new steps. A quiz level could have hundreds of questions but we should group them by category and show a limited amount when playing a level (e.g. 10 or 20 steps to complete a level).

I think we should have a similar design to Duolingo's learning path: icons and the level's name. We should also be able to "connect" a level to a traditional chapter on our topic's learning path. For example, when playing a level a user can get more information by going to the chapter. The same for a chapter: have a button for an "interactive lesson" or "play a quiz" about that subject.

Describe the bug
When we navigate to a lesson, there's a "previous" and a "next" button at the bottom of the page. However, the "previous lesson" button isn't showing up for the first lesson of a chapter.

To Reproduce
Steps to reproduce the behavior:

1. Go to a chapter's first lesson
2. Scroll down to the bottom of the content
3. You'll see a "next lesson" button but no "previous lesson" one

Expected behavior
A "previous lesson" button should be displayed.

Screenshots

Desktop (please complete the following information):

• OS: MacOS 10.13.6
• Browser: Google Chrome
• Version: 81.0.4044.122

Is your feature request related to a problem? Please describe.
There's no easy way to create a new post if we're inside other pages (e.g. posts).

Describe the solution you'd like
We should add a "create post" button/icon to the navbar (next to the notifications icon). We can do something similar to Reddit.

Is your feature request related to a problem? Please describe.
Sometimes we start writing a post but it takes some time to finish them we risk losing everything if something happens.

Describe the solution you'd like
We should have a way of saving drafts of posts before we publish them. We should also have a new menu where we can list all drafts a user created.

Note
Drafts should be visible to the author only.

Is your feature request related to a problem? Please describe.
After we implement drafts (#36), we should also have a way for auto-saving them as we type to avoid data loss in case something happens.

Describe the solution you'd like
Auto-save drafts as we type them.

Is your feature request related to a problem? Please describe.
There's no easy way to see when someone commented on my posts.

Describe the solution you'd like
Send a notification when someone comments on a user's posts.

Describe alternatives you've considered
N/A.

Additional context
The following functionalities should be implemented:

• Send a notification when a comment is made on a post
• Add comments to notification settings
• Send a notification when a reply is made to a comment
• Don't send a notification when the commenter and the author are the same
• Clicking on the notification goes to the comment page

Is your feature request related to a problem? Please describe.
The menu for topics and groups is taking too much space on mobile. It's hard to get to the real content.

Describe the solution you'd like
We should have a dropdown menu or something similar.

Additional context

Describe the bug
The edit history page has some extra spacing between items.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://en.zoonk.org/edits
2. You'll see some extra spacing between items.

Expected behavior
We shouldn't have spacing between items.

Screenshots

Current page:

Expected:

The rich-text editor isn't working on Android, so we've disabled it for now. It's a known Slate issue. Some places to get started:

• This comment mentions a possible workaround

There also some related issues:

• ianstormtaylor/slate#3112
• ianstormtaylor/slate#3313
• ianstormtaylor/slate#3470
• ianstormtaylor/slate#3564
• ianstormtaylor/slate#3573

Describe the bug
When we navigate to a post list (e.g. home page), we see a link on the thumbnail image. However, it doesn't contain an accessible name. Hence, it cannot be read by screen readers.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://en.zoonk.org
2. Inspect any image from the post list
3. Accessible labels are missing

Expected behavior
Those links should have an aria-label.

Is your feature request related to a problem? Please describe.
Right now, our topics are attached to Wikipedia. That means we're using Wikipedia API for searching and creating topics. That also means we cannot create a topic if it doesn't exist on Wikipedia.

That's good for standardizing topic names and to avoid vandalism/spam. However, that brings some problems because some topic names aren't available on Wikipedia. Even if we want to create a page on Wikipedia, that's not very straightforward because we're subject to their own rules.

For example, some time ago I wanted to create some lessons teaching Next.js - the web framework we're using for developing Zoonk. However, the Next.js page on Wikipedia wasn't approved by Wikipedia moderators based on the notability criteria (meaning their moderators think Next.js isn't notable enough to be on Wikipedia even though they allow a page about Nuxt.js, which is a similar framework).

So, I think it's not good for Zoonk in the long-term to be subject to arbitrary moderation rules created by Wikipedia moderators.

Describe the solution you'd like

The topic creation feature should be independent from Wikipedia. We should allow users to create/search topics directly on Zoonk.

Additional context

There's some extra work to make it work properly:

• We need to replace the current search
• We need to account for unexisting topics (i.e. users should be able to easily create new topics while searching for a topic name)
• We need to work on a tool for merging duplicated topics (#7)

Is your feature request related to a problem? Please describe.
For me it is really important for context and to judge relevancy of articles and posts to be able to see the date of when the text was authored

Describe the solution you'd like
At a minimum I would love to see the date on the detail page in the hero section

Is your feature request related to a problem? Please describe.
Even though we limit image sizes when users are uploading them, they're still large and inefficient. Plus, sometimes we only need a thumbnail (e.g. for posts list). We shouldn't load the whole image.

Describe the solution you'd like
We should optimize all images from posts, topics, and groups. We should consider using formats such as WebP and create different image sizes (e.g. thumbnails).

Additional context
Posts can have multiple images and they can also come from external sources (e.g. image from links added to the references). When should optimize all those images and, when coming from external sources, we should copy and upload them to our storage bucket.

Is your feature request related to a problem? Please describe.
When accessing a user's profile, I can't see the comments they made.

Describe the solution you'd like
Add a "comments" section to a user's profile.

Describe alternatives you've considered
N/A.

Additional context
The following functionalities should be implemented:

• A list of the latest comments are displayed on the user profile
• A button to display all comments is displayed
• A "no items" message is displayed when there are no comments
• Clicking on the comment goes to the post

Is your feature request related to a problem? Please describe.
When giving an answer to a question, it requires more context and rich-text features (e.g. adding an external link, a video, a code snippet, etc.).

Describe the solution you'd like
We should enable the new rich-text editor to comments as well.

Is your feature request related to a problem? Please describe.
It's hard to know when a user posts something new.

Describe the solution you'd like
A new feature that allows users to follow others.

Describe alternatives you've considered
N/A.

Additional context
This ticket should implement the following functionalities:

• When a user posts something, adds the post to their followers' timeline
• When a user unfollows another user, remove their posts from the timeline
• Send a notification when a user starts following you
• Add a link to view the user profile on the notification
• Add a follow/unfollow button to the profile page
• Add followers list to user profile
• Followers list is private (not visible to other users)
• Add following list to user profile
• Following list is private (not visible to other users)
• Display a following/followers count

Is your feature request related to a problem? Please describe.
When someone reports a post, there's no easy way to find what post or edit was reported.

Describe the solution you'd like
We should display a link to the specific activity being reported.

Additional context
We need to create an activity page for that.

Edit pages have a "go back" button on top of the edit form. We should add a breadcrumb instead.

Is your feature request related to a problem? Please describe.
When going through a chapter, I don't have any sense of progress (what I've completed or not).

Describe the solution you'd like
We should add a progress bar to the:

• Chapter page (8e61df4)
• Topic page (46c5199)

Additional context
We might have to review the backend for how we handle chapter/topic progress. We're currently marking posts as read when we visit them. Then, we calculated how many posts are completed and how many there are in that chapter or topic. But what about deleted lessons? We need to remove them from the user's progress as well.

We also need to consider how we're going to handle a topic's progress. Are we going to count every post or lessons only?

The topic page timeline should look similar to the home page. We should include a "share post" form. The placeholder should be something like "What did you learn about topic title?"

Is your feature request related to a problem? Please describe.
We don't have an easy way to see when a user account was created.

Describe the solution you'd like
We should include a createdAt field to the user data collection when an account is created.

Is your feature request related to a problem? Please describe.
When I'm adding a reference, it automatically fills in the title and description. However, videos aren't added to the post as one might expect to happen.

Describe the solution you'd like
When creating a reference and the link is a video, we should automatically add/embed it to the editor.

Describe the bug
When we have a list on a post, it doesn't display correctly on mobile Safari (iPhone 6 Plus).

To Reproduce
Steps to reproduce the behavior:

1. Go to https://pt.zoonk.org/posts/como-sugerir-novas-funcionalidades-rnjtq9jnx
2. Scroll down until you an ordered list
3. There's no padding/margin

Expected behavior
The padding/margin should match other paragraphs.

Screenshots

Smartphone (please complete the following information):

• Device: iPhone 6 Plus
• OS: iOS 12.4.8
• Browser: Safari
• Version: 12

Describe the bug
Click on the comment or Question like button multiple and check the issue. See this screen recording for the issue
https://drive.google.com/file/d/1XrtA1I3AKptprFUlTRM7_TAvX-FawxSS/view?usp=sharing

To Reproduce
Steps to reproduce the behaviour:

1. Go to 'any question'
2. Click on 'like button multiple times'
3. See error

Expected behaviour
Like button should get disabled after like/unlike or there should be throttling of response to avoid multiple API calls.

Screenshots
https://drive.google.com/file/d/1XrtA1I3AKptprFUlTRM7_TAvX-FawxSS/view?usp=sharing

Desktop (please complete the following information):

• OS: [Mac ]
• Browser [Chrome
• Version [81]

Is your feature request related to a problem? Please describe.
It should be easier for admins to get some basic usage stats such as posts created, registered users, etc.

Describe the solution you'd like
Add a basic stats dashboard to the /admin page. Those stats should include the following data:

• Posts
• Posts per category (e.g. books, courses, examples, etc.)
• Topics
• Chapters
• Comments
• Registered users

Tasks

• Create security rules for admin collection
• Create function for updating posts count
• Create function for updating post category count
• Create function for updating topics count
• Create function for updating chapters count
• Create function for updating comments count
• Create function for updating users count
• Deploy firestore to staging
• Deploy firestore to production
• Deploy functions to staging
• Deploy functions to production
• Data migration
• Update frontend to display stats

Describe the bug
We're often getting an error when querying a list of posts:

@firebase/firestore: Firestore (7.13.2): Could not reach Cloud Firestore backend. Backend didn't respond within 10 seconds.

It might be related to firebase/firebase-js-sdk#2923

Enabling experimentalForceLongPolling might help:

firebase.firestore().settings({ experimentalForceLongPolling: true })

There's too much spacing between the card edge and the content on postcards from the post list. We should decrease that spacing.

In the latest Firebase release, they've created a new ignoreUndefinedProperties. This is useful to avoid having to filter undefined fields in the frontend before making a Firebase request. We should enable it by default.

Describe the bug
When we add links to a post, they're added to the references at the bottom. However, email links shouldn't be added.

To Reproduce
Steps to reproduce the behavior:

1. Create a new post
2. Add a link to the content
3. Save your changes
4. Navigate to the recently created post
5. Scroll down to the references list
6. You'll see the email link there

Expected behavior
Email links shouldn't be included in the references.

Additional context

Remove existing email links from the database.