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

Suggestions for getting started guide #1106

Closed
anupama-pathirage opened this issue Nov 18, 2024 · 2 comments
Closed

Suggestions for getting started guide #1106

anupama-pathirage opened this issue Nov 18, 2024 · 2 comments

Comments

@anupama-pathirage
Copy link
Contributor

Current Limitation

1. Page loading time is very low with the gifs. Sometimes, when switching tabs, it takes ~8 seconds to load the page or the same time to load the gifs when scrolling. The page is getting frozen frequently as well. So, consider removing some unnecessary gifs from obvious steps or shortening them.

2. Find the source code in the downloads tab is a bit misleading as it implies we need to build from the source

image

3. Run on Docker steps are missing in GH Release Note (E.g. APIM Release note has it)

4. Wrong link in in https://mi.docs.wso2.com/en/latest/get-started/quick-start-guide/#prerequisites
It should point to https://mi.docs.wso2.com/en/latest/develop/mi-for-vscode/install-wso2-mi-for-vscode/

image

5. Make the external links open in a new tab

image

6. Have clean screenshots and gifs without having too much clutter in recent projects and file systems.

e.g. in Step 1 and same issue there is in Step 4 Gif as well

image image

7. Wrong context field value in Step 2

image

Current Value : hello
Correct value: \hello

8. Step 4, 1st and 2nd points should be re-written.

image

Suggestion :

Open the VS Code Command Palette by selecting View > Command Palette from the menu, or by using the shortcut Command+Shift+P on macOS or Ctrl+Shift+P on Windows.

Suggested Improvement

Given in line

Version

No response

@DinithiDiaz
Copy link
Member

PRs: #1107, #1120

@DinithiDiaz
Copy link
Member

Suggestions 1,6

  • Reduced the size of the images by compressing them.
  • Replace some GIFs, where the steps are obvious, with images.
  • Replace the remaining GIFs with shorter versions by editing the screen recording video. Reduced file sizes.
  • Reduced the total file size of the media used in the QSG.
  • Changed via Update QSG media #1120

Suggestion 2
This will be addressed by the product marketing page revamp effort.

Suggestion 3
Created a git issue to track the task.

Suggestions 4,5,7 and 8
Changed via #1107

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