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

Adding getting started with wsl2 into docs #1546

Merged
merged 4 commits into from
May 25, 2023

Conversation

eduardomr
Copy link
Contributor

@eduardomr eduardomr commented May 11, 2023

Closes #1545

Co-authored-by: José Luís Ramos <78660807+joseluis-rt@users.noreply.github.com>
Co-authored-by: Klyssmann Oliveira <56873266+klyssmannoliveira@users.noreply.github.com>
Copy link
Member

@wwahammy wwahammy left a comment

Choose a reason for hiding this comment

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

It looks fine to me! Did you verify this actually all works? 😄

@wwahammy
Copy link
Member

@eduardomr quick tip for the future: If you put the line Closes # in your PR description up top, it will automatically close the the original issue when this PR is merged. It's super helpful!

I'll do that for you this time but in the future, please do so yourself.

@wwahammy
Copy link
Member

Hey all, it looks like the markdown lint didn't quite work. The reason is probably because you, reasonably, copied this info from README.md and we specifically exclude README.md from linting right now.

We won't worry about that this time but, in another PR, I encourage you to remove the exclusion for README.md and correct all of the markdown linting issues in both files.

eduardomr and others added 3 commits May 22, 2023 14:12
co-authored-by: Eduardo Maia <emaiarezende@gmail.com>
co-authored-by: Klyssmann Oliveira <56873266+klyssmannoliveira@users.noreply.github.com>
Co-authored-by: Klyssmann Oliveira <56873266+klyssmannoliveira@users.noreply.github.com>
Co-authored-by: Eduardo Maia <emaiarezende@gmail.com>
@eduardomr
Copy link
Contributor Author

Hey all, it looks like the markdown lint didn't quite work. The reason is probably because you, reasonably, copied this info from README.md and we specifically exclude README.md from linting right now.

We won't worry about that this time but, in another PR, I encourage you to remove the exclusion for README.md and correct all of the markdown linting issues in both files.

I apologize in advance if this question seems too basic, but I couldn't locate the exact file where this exclusion is being specified.

Could you please guide me to the file responsible for removing the README file from the lint configuration?

@wwahammy wwahammy merged commit c29bae3 into houdiniproject:main May 25, 2023
17 checks passed
@wwahammy
Copy link
Member

@eduardomr I just realized that the markdown linting config is not easy to modify. Could you file an issue which mentions we need to lint all of the markdown files in the repo and eliminate all of the exclusions? As part of that, you should mention it's not clear where the markdown linting exclusions are set.

@eduardomr
Copy link
Contributor Author

@wwahammy Okay! i'll open the issue

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.

[FEATURE] Houdini installation and configuration documentation with WSL2
3 participants