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

Feat : Troubleshooting Page #379

Open
wants to merge 6 commits into
base: lean4
Choose a base branch
from

Conversation

Shreyas4991
Copy link

@Shreyas4991 Shreyas4991 commented Oct 14, 2023

In this PR I add a page to the website which accumulates common problems that users encounter with their lean installation. I further wish to link users from vscode error messages to this URL in a separate PR on the extension repository. Please see Zulip for the discussion that led to this PR.

@fpvandoorn
Copy link
Member

I think this page could be a good idea (though some of the troubleshooting should be inlined in the relevant places).

However, I don't think we should merge this until there are a few helpful tips on the new page. Therefore, I'm marking this PR as awaiting-author for now.

@Shreyas4991
Copy link
Author

@fpvandoorn : there has been an update. You can find the summary in the RFC issue I raised. Basically it was suggested that this website is not the right place for toolchain issues. I would like to keep this PR around until a decision is made there on that issue.

@Shreyas4991
Copy link
Author

Shreyas4991 commented Oct 17, 2023

@fpvandoorn : For good measure I collected some common problems and added them. I can't seem to change labels, so I can't remove the awaiting-author label.

Fixed a mistake in command not found. the third instruction also works for Linux.
@fpvandoorn
Copy link
Member

I think that these troubleshooting remarks are more useful when they are inlined with the rest of the instructions (maybe in a text box that is collapsed by default, but expandable).

@Shreyas4991
Copy link
Author

Shreyas4991 commented Oct 18, 2023

I think that these troubleshooting remarks are more useful when they are inlined with the rest of the instructions (maybe in a text box that is collapsed by default, but expandable).

Indeed they are useful there. But, in addition to the points made in the lean4 PR, we would like to collect these issues in one place so that we can give a link to it in VSCode error messages, especially in light of all the new features. Providing highly specific diagnoses for each error would be much more difficult. Additionally, there are other threads where people have suggested that such a page should exist.

* If you are on linux, currently the default shell in popular distributions like Ubuntu or Linux Mint is `bash`. In this case, run `source ~/.bashrc`.
* If this still doesn't work, logging out and logging in again should fix it.

### InitializeSecurityContext error on Windows
Copy link
Member

Choose a reason for hiding this comment

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

Having this information in two different places feels like a recipe for confusion to me.

Copy link
Author

@Shreyas4991 Shreyas4991 Oct 19, 2023

Choose a reason for hiding this comment

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

Perhaps we could link to this paragraph from other pages. In such pages we have a section titled "Errors you might encounter" with links

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

Successfully merging this pull request may close these issues.

3 participants