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

Quicker option for running per-module doc stats #126037

Open
matschaffer opened this issue Feb 21, 2022 · 1 comment
Open

Quicker option for running per-module doc stats #126037

matschaffer opened this issue Feb 21, 2022 · 1 comment
Labels
APIDocs Team:Operations Team label for Operations Team triage_needed

Comments

@matschaffer
Copy link
Contributor

matschaffer commented Feb 21, 2022

When working on #125467 (comment) I found I had increased the "Public APIs missing comments" count for the monitoring plugin, so I tried to fix that.

Unfortunately it's a little difficult to know exactly what to do.

I ran node scripts/build_api_docs --plugin monitoring --stats comments as the bot recommends, but that OOMed due to #125079

So I ran node --max-old-space-size=8192 scripts/build_api_docs --plugin monitoring --stats comments but that takes 12 minutes. And it's still a little unclear on what I'm supposed to do with the output.

I seemed to even highlight one of the internal properties of my config object (ui) so I added a comment to that as well (https://github.com/elastic/kibana/pull/125467/files#diff-40e7b7e2305403ec95099600b95bbd777b1711b190ad1cb154abe15b95f4fbceR106). It was really just a guess, but it seems like it worked. A 12 minute test cycle doesn't lend it self to exploring what the "right" way to fix these warnings are so once I got something it seemed happy with, I moved on.

It'd be nice if we had a way to run the checks for just the single module (today it seems to compute for all modules and just show you one).

Or I was also wondering if we could do the check as an eslint plugin per file.

Those seem to run quite quickly from IntelliJ (for example @kbn/eslint/no-restricted-paths) so it's easy to abide by the rule while developing.

@botelastic botelastic bot added the needs-team Issues missing a team label label Feb 21, 2022
@kertal kertal added the Team:Operations Team label for Operations Team label Jun 6, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Jun 6, 2022
@kertal kertal added triage_needed needs-team Issues missing a team label labels Jun 6, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jun 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIDocs Team:Operations Team label for Operations Team triage_needed
Projects
None yet
Development

No branches or pull requests

3 participants