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

Move How to use this ...? information into it's own documentation page? #1120

Closed
alrra opened this issue Jun 5, 2018 · 2 comments
Closed

Comments

@alrra
Copy link
Contributor

alrra commented Jun 5, 2018

Specifying How to use this ...? in every rule/parser/etc. seems a bit much. I think we should have a dedicated documentation page that explains how to install things, and just link to that from all the other documentation pages.

Thoughts?

@alrra alrra changed the title Move How to use this ...? docs into it's own page? Move How to use this ...? information into it's own page? Jun 5, 2018
@alrra alrra changed the title Move How to use this ...? information into it's own page? Move How to use this ...? information into it's own documentation page? Jun 5, 2018
@molant
Copy link
Member

molant commented Jun 6, 2018

IIRC we added this for the individual packages in npm (e.g.: https://npmjs.com/package/@sonarwhal/rule-https-only) so people finding us via there have a bit more of context.

I'm ok having a dedicated page under user-guide that explains this and update the rules to point there.

@molant
Copy link
Member

molant commented Jan 17, 2019

I think that having the information in each package for npm is important. Also the create-hint package takes care of this so closing this issue.

@molant molant closed this as completed Jan 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants