-
Notifications
You must be signed in to change notification settings - Fork 749
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
docs: add links to issue impact #4207
Conversation
Paul Orton seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Thanks for the pr. The However, that'll add a lot of duplicate links to the page, so we should discuss with @WilcoFiers how we want to handle that. |
Ahhh I see! Thanks for the heads up. Maybe a link in the table header then or a footnote somewhere? |
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.
@ortonpaul Thank you for the contribution, but I think this is a little much. One link in the API.md file, and one link in the rule description file is probably enough. As Steve pointed out the rule description file is generated. To update it you'll have to change some code in build/configure.js.
You may also want to consider putting a link into the readme somewhere. I'm open to suggestions on where.
@ortonpaul are you still interested in doing this work or could I close the pr? |
#4300) Just adding a code comment to the `rule-descriptions.md` file to note that it is a generated file. Spawned from a discussion in #4207 (comment).
Closing due to inactivity |
Add links to the Issues Impact page at a few spots in the documentation in response to #3942. Let me know if there are other places you can think of that make sense 👍🏼