-
Notifications
You must be signed in to change notification settings - Fork 13.9k
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
Sub step about closing TOP in Windows and reminder to follow Linux instructions. #28356
Sub step about closing TOP in Windows and reminder to follow Linux instructions. #28356
Conversation
upon running npm run lint :project -- "path" , there is no error but running lint:lesson produces an error : Required heading structure [Expected: ### Lesson overview; Actual: #### Be mindful of the OS you are using]. is there something i should do about this or can do about this ? |
For this lint error, could you replace the first line with the following: <!-- TODO: Revisit lesson/heading structure to remove need to disable rules -->
<!-- markdownlint-disable MD024 TOP004 --> The error's flagging because the current disable comment targets the wrong rule code, but we also need the TODO because this (and a few other installation lessons) have structures we need to rethink for accessibility reasons. They're lower priority for now, but we need the TODOs for when we get to them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, looks good to me! Just wondering about the escaped underscore...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have any further issues with this.
Hi @MaoShizhong , sorry for abruption but i have solved the issue and wanted to remind you that the PR is ready to be merged, just in case it slipped the maintainers' radars. |
@xandora Forget to hit merge for this? 😜 |
Because
As mentioned in the issue , regardless of many sentences throughout the beginning that asked the users to do everything in VM have not been effective , so a specific highlighted sub step was required . There was also need of a reminder to be added that learners only follow the Linux instructions from now on.
This PR
Issue
Closes #28325
Additional Information
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section