joshpc/recordvault-issues

A public issue repository for https://www.RecordVault.io

recordvault-issues's Issues

"Unsaved Changes" Occurs when not making changes

Describe the bug
You can arrive on a page, and navigate away, and be told that there are changes to save.

To Reproduce

1. Log in.
2. Pick an article.
3. Don't make changes, and navigate away.

Expected behaviour

1. It should not ask you if you have not made any changes.

Additional Context
This is an issue with quill comparing Deltas. This appears to have been an issue in a version bump.

Subdomain Vaults

What do you want solved?
I want the url of my vault to be myvault.recordvault.io instead of recordvault.io/vaults/...

Describe the solution you'd like
I want my own subdomain per vault.

Additional context
SSL certs need to keep working.

Markdown support

What do you want solved?
I would love the ability to copy and paste a markdown file into Recordvault, and to not have to apply additional formatting line-by-line. (the right click menu option is more than a little fiddly.)

Describe the solution you'd like
The option to copy and paste a markdown file into the editing field, and have the formatting be applied.

Describe alternatives you've considered
The alternative is to paste a document into the text field, and then have to go through an article line by line, highlighting each part that needs formatting applied. It's not really practical.

Image Captions

What do you want solved?
I should be able to add a caption to my images.

Describe the solution you'd like
There should be a dedicated area below an image where I can enter a caption.

Describe alternatives you've considered
We can have overlaid captions as well (most images being used are large.)

Additional context
Optional: Would be nice to format the text in the caption (bold, italic, link, etc.)

Article title shifts when creating a new article on Firefox for Mac

Describe the bug
In Firefox for Mac, the Article Title will shift once you enter a title.

This occurs because we estimate what the height of the scrollView will be if it had a line using the font's lineHeight property. This is an approximation; scrollViews don't have to respect this. Chrome and Safari does, generally, but Firefox does not.

This results in the content shifting down just a little.

To Reproduce
Using Firefox

Steps to reproduce the behaviour:

1. Create an article.
2. Type a title

Expected behaviour
The content should not shift.

Browser and Device (please complete the following information):

• Firefox, Mac

Tooltip opens at the wrong spot on Relationships and References View

Describe the bug
The tooltip does not open at the correct location on the Graph/References View

To Reproduce

1. Go to an article with 5+ relationships.
2. Click on a link. The tooltip will open.
3. Scroll down a little and click another link. The tooltip will open as well.

Expected behaviour
Should open under the article.

I get logged out from time to time

Describe the bug
It is possible to get logged out for unknown reasons.

To Reproduce
Unsure. On errors, you sometimes get logged out.

Expected behaviour
You should remain logged in until your session terminates.

Hidden Notes

What do you want solved?

1. I want to write articles but not show them to everyone.
2. I also want to write a portion of an article and not show the notes to everyone.

** Steps**
For the time being, this will be restricted to notes on articles instead of completely hidden articles.

• Add hidden_notes to Articles.
• Add hidden_notes to the Graph
• Add a way for owners to view notes.

• Ensure that non-owners cannot overwrite notes
• Add a way for owners to edit notes.

Describe the solution you'd like
I need a way to go from an article to the "notes" section.

Additional context
Eventually we'll want to consider collaborators as well.

Revamped Vault Settings Page

What do you want solved?
Vault Settings does not offer many options, nor is it well done. It was quickly put together, but needs to be polished.

Describe the solution you'd like

1. We should have a preview of the banner.
2. We should be able to invite collaborators via e-mail, not just username.
3. Invitations should be accepted, not default-added.
4. Users should have permissions (Owner/Collaborator)

Additional context
This likely involves #6 (Private Vaults)

Graph/Reference buttons are not visible in portrait mode on a tablet

Describe the bug
The graph and reference buttons are hidden offscreen on tablets in portrait mode.

To Reproduce

1. Open an article
2. Look for buttons

Expected behaviour
Buttons should be available at the bottom of the screen.

Dark Mode

What do you want solved?
I sometimes read articles at night and the black text on white is jarring.

Describe the solution you'd like
I'd like to be able to activate dark mode somewhere within the app.

Describe alternatives you've considered

• Better support of "Reader Modes" in browsers. This is unreliable; some browsers require a certain number of words being available (512 in Firefox, for example). This is not a standard.

New tags are not indexed

It looks like not all tags are being indexed.

The indexing process is not tested

Describe the bug
We don't test whether or not an article or tag is indexed.

Lists feel "cramped" when surrounded by paragraphs.

Problem

Right now, lists have a bit of padding at the top and at the bottom.

Expected

There should be more spacing at the bottom in order to more easily read the article.

Refactor how Article/Graph/References work to avoid unnecessary reloads

What

Right now Article, Graph, and References are implemented with a similar core but require a page load to swap between them. We can do better!

Clean up s3 buckets

What

We have an excessive amount of buckets. Remove unnecessary ones.

Following the confirm link a second time does not have a friendly UX

Describe the bug
By confirming a second time you're brought to an error screen.

To Reproduce
Confirm twice.

Expected behaviour
You should just be brought to / -- ideally with a message saying "that code has already been used!" or even better "that code has expired!"

Constantly being signed out

Describe the bug
I am being signed out after only several minutes of being logged-in on the site.

To Reproduce
Steps to reproduce the behaviour:

1. Log in
2. In my case, I have been trying to edit an existing article. So I am navigating to this page, and making some edits.
3. Upon either pressing ctl-S, and using the bottom "save" button (I've done these multiple times). An error message displays indicating that the article was unable to be saved, and I may have been logged out.
4. Only when I navigate back to the main Recordvault page, is this properly confirmed, as I'm again presented with the login screen.
5. It's interesting to note that though I am apparently logged out I am able to view the details of my account page.

Expected behaviour
First, that I would remain logged-in to the site for a "reasonable" length of time. During this period, I'd expect my edits to save. I would not receive an error saying I had been logged out every time I try to do so. (This is occurring after only a few minutes' worth of activity on the site. )

Browser and Device (please complete the following information):

• OS: Windows 10
• Browser Vivaldi
• Version Windows 10 OS Build 17763.615

The "X" button on contributors stretches out to the full width of the container, instead of just looking like a button.

Fav Icon

What do you want solved?
A fav icon would make the site more complete.

Describe the solution you'd like
Coming up with a picture is the hard part... Am not artistically inclined but considered an isometric cube with a quill painted on the side.

Switch to Editor.js

What

Change the underlying editor to Editor.js (a more modern, and easily customized editor)

• Update backend format to be editor.js instead of Quill
• Use Editor.js as main editor on front-end
• Remove Quill

Article CSS Simplication and Visual Tweaks

What

1. Simplify CSS by removing quill's styling.
2. Add a bit more personality to articles

It should be obvious that you have unsaved changes

What do you want solved?
When editing a page I never know when I have unsaved changes until I begin to navigate away.

Describe the solution you'd like
I'd like to see some indication, somewhere, that I have to save.

Add Javascript Exception Handling

What

We should have a net to capture and log javascript errors. Letting them fail silently on the client side will bury problems.

Help page? Basic "How To" Guide?

The vault looks great, and the UI is simple, but I can't figure out how to link/relate/reference one article or element to another. Are there plans to put this in a simple help page of some kind?

Apologies if I've just signed in too soon and features are in development. I arrived by blindly following another user's content.

Save sometimes fails

Describe the bug
Saving sometimes fails silently.

To Reproduce
If you have information on how to reproduce this please let me know.

Expected behaviour

• Saving should alert you of failures (i.e. if you end up offline)
• This should not cause an error or log you out

Relationship and Tag Exporting

What do you want solved?
Access to all relationships and tags in tabular format.

Describe the solution you'd like
Either displayed in an RV page or as an export function (CSV).

You'd need two tables.

1. Articles Table (Article Title, Tag).
   Each Title-Tag combination requires a new entry/row.
   DO
   Ikora, Character
   Ikora, Wizard
   DON'T
   Ikora, Character, Wizard

2. Relationship Table (From Article Title, To Article Title, Relationship)
   e.g. Ikora,Renaud,Friends

Describe alternatives you've considered
There is value is displaying these tables directly in the browser (e.g. quality control). But for any other purpose (data analysis, visualizations, etc.) a simple CSV export is just fine.

Additional context
I assume this information is already being stored logically (relational tables?). If so the task should be straight-forward.

This is the first step in enabling the visualization of relationships which would definitely set RV apart from everything else.

Issue Saving article with new picture

Describe the bug
Saving an article when a new picture has been uploaded creates an error notification and logs me out.
Error Message: "Failed to save: An application error ([object Object]) occurred on our end. This is a bug! We're working on fixing this"

To Reproduce

1. Insert a new picture in https://www.recordvault.io/vaults/freeport/articles/freeport-2-arc-1
2. Click Save.

Expected behaviour
Article saves with new picture.
Stay logged in.

Browser and Device (please complete the following information):

• Windows PC
• Firefox 60.4.0esr (32-bit)

Additional context
This was replicated a few times with the exact same outcome. Saving text only presents no issue.
Did not try in a different article.

You can press the "add image button" even if it's not visible

Describe the bug
When mousing over the left side of the editor, you can see your cursor swap to a finger.

To Reproduce

1. Use chrome
2. Have the "add image" button appear.
3. Make it hide
4. Mouse over where it disappeared.

Expected behaviour
It should not be there.

Browser and Device (please complete the following information):

• Chrome

Refactor tooltips

What

Tooltips are created inconsistently and very roughly.

• All tooltip bubbles should use a single Tooltip frame.
• Tooltip bubbles should include panels that are easily customizable and use shared components.
• CSS Should be refactored to a single location and cleaned up.

Tag search does not appear to always return results.

Chrome does not render article titles correctly when screen is narrow

What

This only occurs when the page is fully-condensed. Looks like a breakpoint issue.

Add Relay Cache

What do you want solved?
We currently reload every single article when going back. We can cache the results of a graphql and make HEAD requests to see if the data's been updated.

Goals

1. Reduce number of loading indicators
2. Prevent loss of location when going back in a list

Host front-end in an S3 bucket

What

We have a lazy solution to put the front end on Heroku. It doesn't need to run there, and the package can just be on S3.

Confirming does not always log you in

Describe the bug
Confirming a account while signed in leaves your account in a bad state.

To Reproduce

1. Sign in
2. Log out (somehow)
3. Create a new account
4. Press 'confirm' in the email

Expected behaviour
Confirming should auto-log you in.

Actual
You're brought back to / but you are not signed in. Your account does successfully get confirmed.

Additional context
It appears that devise_token_auth is returning credentials for the previously logged in account.

The "X" button on the search bar overlaps with the search box.

Save Hotkey

What do you want solved?
I would like to edit articles without relying on the mouse to trigger actions.

Describe the solution you'd like
CMD/CTRL-S for saving.

Image controls show full size SVGs

Describe the bug
When selecting an image to customize how it is displayed, the buttons are massive

To Reproduce

1. Be logged in
2. Select an image you can edit

Expected behaviour
A small toolbar is supposed to show up and show the buttons

Test AlloyEditor

See if AlloyEditor is right for us!

Private Vaults

What do you want solved?
I want to create a vault that can only be accessed by myself or collaborators.

Describe the solution you'd like
I should be able to create a vault and make it optionally public, rather than default public.

Switching between sorting styles will cause "Load More" to spin indefinitely when viewing articles

What

Switching between sorting styles will cause "Load More" to spin indefinitely when viewing articles

Expected

Load More should not be spinning and should respect the loaded state.

Javascript console error when adding image

Describe the bug
The Add Image feature is not working right now.

To Reproduce
Steps to reproduce the behaviour:

1. Go to the Reflector article.
2. Click on the circle button to add an image and select an image. I tested with png jpg and gif. All same results.
3. Observe that the article stays the same.
4. Hit F12 and notice that a new entry appears in the javascript console.

Expected behaviour
The image that I selected from the File Select dialog should appear in the article at the caret position I selected.

Screenshots
Console error on Chrome:

Console error on Edge:

Browser and Device (please complete the following information):

• OS: Windows 10
• Browser Chrome and Edge
• Version, Chrome 71.0.3578.98 (Official Build) (64-bit),
  Microsoft Edge 42.17134.1.0

Additional context
This used to work. One of the last images I remember uploading successfully was for the Lune article in Freeport. Hope that helps narrow down a point in time before something changes.

Delete images from s3 when removed from articles

What

We store images indefinitely. This can become pricy.

Too many db queries

Describe the bug
We run too many db queries under the covers. Authentication requires running 2-3 queries.

1. Audit the app. Identify list of excessive queries.
2. Trim them down however possible.