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

error message #1177

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

error message #1177

wants to merge 2 commits into from

Conversation

alexr018350
Copy link

Description of your changes

Fixes #1175

I have:

  • Read and followed KubeVela's contribution process.
  • Update sidebar.js if adding a new page.
  • Run yarn start to ensure the changes has taken effect.

Special notes for your reviewer

@chivalryq I had trouble previewing changes locally. Can you preview these changes?


```
Installing VelaUX:
Error: "unable to find velaux addon" - This may occur if there is an issue with locating the velaux addon. To resolve this, make sure that the velaux addon is installed properly by running the "vela addon enable ~/.vela/addons/velaux" command. If the issue persists, check the advanced installation arguments for the velaux addon.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What command will report "unable to find velaux addon"?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If vela addon enable ~/.vela/addons/velaux report "unable to find velaux addon"

Copy link
Member

@chivalryq chivalryq Feb 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sure that the velaux addon is installed properly by running the "vela addon enable ~/.vela/addons/velaux

This is a bit confusing. VelaD packed a velaux addon with it and unzip it to ~/.vela/addons/velaux when velad install. Advice here should be more clear.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"To resolve the "unable to find velaux addon" error during VelaUX installation, you can try running the following command to enable the velaux addon: "vela addon enable ~/.vela/addons/velaux". This addon should have been installed automatically by VelaD during its installation process. If the issue persists, try reinstalling VelaD."

Is this clear?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This addon should have been installed automatically by VelaD during its installation process.

This is wrong! addon is unpacked to local directory, not "enabled" (or installed) by velad install by default. User can decide to enable it or not. If they do, they can run vela addon enable ~/.vela/addons/velaux.

Besides, you said "vela addon enable ~/.vela/addons/velaux" causes this error. You shouldn't ack user to run it again to solve it.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood!

@chivalryq
Copy link
Member

chivalryq commented Feb 23, 2023

Please sign the DCO.

BTW, what do you do to preview the changes?

@alexr018350
Copy link
Author

Please sign the DCO.

BTW, what do you do to preview the changes?

Used local server by running yarn start. There was no reflection of the changes.

@chivalryq
Copy link
Member

But there's a syntax error.
image
If I remove that, it works.
And yarn start should work. What do you mean by "no reflection"

Signed-off-by: alexr018350 <[email protected]>
Signed-off-by: alexr018350 <[email protected]>
@alexr018350
Copy link
Author

But there's a syntax error. image If I remove that, it works. And yarn start should work. What do you mean by "no reflection"

I am facing an issue with my local server while making changes to standalone.mdx file. Whenever I make changes to this file, I am not able to see the changes on the website. Strangely, if I make changes to any other .md file, I can see those changes on the website locally.

I have already tried removing and re-installing node modules, as well as switching between npm and yarn, but it did not work. I also tried using incognito mode to resolve any caching issues, but in vain.

@alexr018350
Copy link
Author

Screenshot from 2023-02-23 13-09-32
Screenshot from 2023-02-23 13-06-36
Screenshot from 2023-02-23 13-06-15

@chivalryq Frustrated since yesterday.

@chivalryq
Copy link
Member

@alexr018350 OK I got where's the problem. The document is versioned and you changed the latest version which you have to select Next in the top-right tab.

@chivalryq
Copy link
Member

I think maybe it's better to open a section in the last say "Trouble Shooting". WDYT @wonderflow

@alexr018350
Copy link
Author

@alexr018350 OK I got where's the problem. The document is versioned and you changed the latest version which you have to select Next in the top-right tab.

Yup, can see now. Thanks

@alexr018350
Copy link
Author

I think maybe it's better to open a section in the last say "Trouble Shooting". WDYT @wonderflow

Yes, we can include common mistakes, potential issues, and tips for resolving problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include common errors on installation page that users may encounter
2 participants