Last updated

Issues spotted Training 1 & 2

  • We were confused when trying to change from realm to revel package, we were getting product mismatch error on build. We didn't know why. CleanShot 2024-05-07 at 11.11.09@2x.png

  • Not able to paste image into md file. (I tried to do CTRL+V when copied image to editor, but it didn't work). It was possible to paste image from clipboard on Mac machine, when focus on tree, but it didn't work at all on Windows. I would expect that we can paste image directly, when using editor and editing markdown file. Just as it works on Github.

  • Even when image was uploaded to images folder, it wasn't straightforward to use this image in markdown text. I miss some option to copy image path and paste it directly to my markdown so I don't have to manually type ![image](./images/my-image.png)

  • Editor do not always wrap long text lines, there is no settings for max line length. CleanShot 2024-05-07 at 11.20.04@2x.png CleanShot 2024-05-08 at 11.20.30@2x.png

  • cmd+B not make a text bold

  • Text "uncommited changes" wrap to next line CleanShot 2024-05-07 at 11.16.53@2x.png

  • No indicator when uploading file, it took a while, when I started to upload a file (right click on file tree and selected 'upload files'). I didn't know what was happening so I started second upload and then two files appeared.

  • When you drop img to editor it drop exacly in cursor position, but there is no indicatior, so I assume to put image url to current caret position

  • Wrong caret position for other user CleanShot 2024-05-07 at 11.23.18@2x.png

  • Inconsistent behavior? We dont have realm in our package json, so on Deploy page we can see error:

    🚫 Project has mismatched product library. Your project should use @redocly/realm
    🚫 Project build process failed

    but wysiwyg showing something like that: CleanShot 2024-05-07 at 11.25.56@2x.png After change to realm everything works fine.

  • Upload of each YAML files takes a lot of time, no indicator when I drop on tree view.

  • After adeed apis to redocly.yaml, wysiwyg reloaded and redirect my editor to museum.yaml - I dont want do that!

  • Strange cursor is displayed next to 'uncommited changes' when viewing someone else cursor. strange-cursor

  • It seems strange that it's possible to edit someone else comment on PR's

  • We had a merge conflicts with notes.md file and it completely blocked us from merging PR. We just received error about it, but we didn't see any guidelines how to resolve conflicts.

    • We asked on Slack, and Andrii tell us about "Sync" button on bottom of Editor (we do not see this at all) - it should be somewhere near "conflict message".
    • But we synced main to test-api branch and it rejected all changes from main! We not expected this - there is missing "resolving conflict tool"
  • I tried to add comments and after submiting I need to wait ~15s to see my comment, also I dont have any confirmation that my comment was saved.

  • UI: missing padding CleanShot 2024-05-07 at 11.48.27@2x.png

  • Empty space, there shoud be "something" because it looks like a bug, it should be a text: no reviewers yet, add first one CleanShot 2024-05-07 at 11.51.05@2x.png

  • @Michał Matczuk trigger Sync but it show as Anonymous: CleanShot 2024-05-07 at 12.22.04@2x.png

  • I was logged out before 8h of inactivity (~2h after login, 10min after last action)

  • When I click on menu item it will redirect me to last opened file in editor. CleanShot 2024-05-07 at 13.05.52.gif

  • I tried to find information about LINT option and there are no results: CleanShot 2024-05-07 at 13.16.15@2x.png

  • After PR merge, branch should be removed.

  • When added lint rules, build failed, but we didn't see what was the error, just 'no data' message: CleanShot 2024-05-07 at 13.24.26@2x.png

  • We were struggling on how to find rule which will enforce specific open api version. We found only spec rule - link

  • When lint step failed, rules button is inactive. I would expect that we will see list of rules that failed there: no-rules.png

  • Documentation: search for scorecard it will put first result to CSS Scorecard which is not what we are looking for.

  • When added scorecard in theme with sample configuration from link it looked like it overriden all rules defined in redocly.yaml without any warning.

  • We are missing documentation for scorecard feature (or we were not able to find it in Beta Docs)

  • Added domain, but after save list of domains not refresh.

  • We were asked to run stats cli, but since we have decided not to use remote content, we didn't know how to run it as we don't have straightforward way of cloning repository to our machine and running redocly cli against it.

  • We were struggling with finding documentation on how to add new changelog subpage to given api documentation. We have checked catalog documentation

  • On PR list we've seen red mark that there are some failed checks, but when going into PR details all checks are green: CleanShot 2024-05-07 at 14.52.51.gif

  • We are missing some confirmation on WYSIWYG that it has refreshed latest changes

  • Filtering API Catalog do not work on mobile size

  • While replying on comment on Pull Request page, someone send a new comment - then list refreshes and I'm losing progress CleanShot 2024-05-08 at 12.51.06.gif

  • Replaying on comment refreshing component and display comments without authors outside of div CleanShot 2024-05-08 at 12.56.42.gif

  • We have synced our branch with main right before merging - as a result we see some strange info user as author of deployment info.png

  • After we've merged one of our PR's we have lost whole content of openapi.yaml file and some strange files appeared on PR review. strange-files-pr.png

  • when I tried open mp4 file it will open on 1s new tab and closig it - I think we should add some information: file type not supported

  • After rename folder from Train Travel to Train Travel API my browser hangs! We also rename file inside train.yaml to openapi.yaml, check our video: CleanShot 2024-05-08 at 13.09.13.mp4, link because preview not working: video SOUND ON

  • Portal rendering MP4 file as image

Issues spotted Training 3

  • Possible to re-open PR for branch which was removed (PR)
  • Switching branches takes too long, list should be updated every time, but we should see cached list of branches anyway to fast Switching
  • Mail about PR should has more information (check Github ones) CleanShot 2024-05-16 at 10.46.47@2x.png
  • Received EMAIL about BUILD FAILED but build not failed CleanShot 2024-05-16 at 10.55.43@2x.png