CrowdStrike / CrowdStrike/foundry-js

Improve documentation

Open
#91 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
9
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Hey, I tried to use foundry-js in a foundry app and had lots of trouble understanding some things. Here are some suggestions on things to add to the documentation to improve adoption from developpers:

  • Add an example on how to supply input for parameterized queries for Logscale. After a support ticket, I found that this is documented somewhere in the logscale documentation, but there should at least be an example here
  • Add an example on how to supply an end time for a logscale query. I had to dig deep in the code to find that, not a nice experience.
  • Clarify what can be done with logscale from the javascript vs what can be done with custom queries in a foundry app. I was under the impression that I could gather sensor data from the JS library. However, this is NOT the case, as support told me. More importantly, there is NO error message if you try to gather sensor data from JS, you just get a response with zero results, which pretty much gaslight you into thinking that it's your query that is wrong, which is not the case. Very frustrating.

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation entry points for parameterized LogScale queries, query end times, and the foundry-js versus custom-query capabilities. Verify the documented JavaScript behavior for sensor data, then update the relevant documentation with examples and clear limitations; done means users can find these answers without searching external LogScale documentation or source code.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.