-
Notifications
You must be signed in to change notification settings - Fork 24
Fix docs #405
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
base: main
Are you sure you want to change the base?
Fix docs #405
Conversation
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.
Good looking stuff! Tagged in @ianjennings about the TD_THIS_FILE
variable being public vs. an "internal" variable we use for postrun.yaml
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.
Some minor changes, probably want to remove that setup guide, since we don't need those deps anymore.
2. **API Key**: Your API key is used to authenticate your requests to the TestDriver API. You can regenerate it if you suspect it has been compromised. | ||
3. **Usage & Billing**: Monitor your usage and billing information. This includes your current plan, usage limits, and billing history. | ||
2. **Personal API Key**: Your personal API key that you can use for creating the tests. | ||
3. **Shared API Key**: Your shared API key that can be used for CI/CD workflows. |
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.
remove
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.
Yes, so I made changes for the "user specific API key", like I added new image assets and all the other stuff, recently I saw we moved back, so I need to revert these 😕
- name: Set up Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: "20" | ||
cache: "npm" | ||
|
||
- name: Install dependencies | ||
run: NODE_ENV=production npm ci | ||
|
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.
you sure we don't need this? how does npx
run?
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.
Yes, node is auto installed on gh runners - https://github.com/actions/runner-images/blob/f9af77a3ce3364571dbca2873e9bcb5764211223/images/ubuntu/Ubuntu2204-Readme.md?plain=1#L21
I wanted to see if it actually works, so I tried it on our s&s repo and its does - https://github.com/testdriverai/sourceandsummit/blob/d457e95016e8b29162e0d60c11f420c3420ab16d/.github/workflows/testdriver_v6.yml#L92-L122
docs/getting-started/setup-local.mdx
Outdated
#### Install Python & Visual Studio build tools | ||
|
||
```powershell | ||
choco install python visualstudio2022-workload-vctools -y | ||
``` | ||
|
||
#### Install Node.js |
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 think this is still true?
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.
this page will be hidden and will not be indexed (https://github.com/testdriverai/cli/pull/405/files/c38dada7555f7f1edccf5eaba6bbca285f2f0ab5#diff-50bd76e1e2b56dd4d7722b0a2ae3cb2804eb4f18ae8a3b50f9b1f38e5dc51a11R6), I just kept it in case we resume doing locally again, we can just pick from here
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.
we should delete it if it's not used
code stays in github forever, don't be afraid to delete!
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.
Got it
makes sense!
docs/getting-started/setup-local.mdx
Outdated
```powershell | ||
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser | ||
``` |
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.
We don't need this anymore.
docs/getting-started/setup-local.mdx
Outdated
<Card title="Test Copilot" icon="link" href="/getting-started/writing"> | ||
Write custom tests | ||
</Card> | ||
</CardGroup> |
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.
This page probably isn't needed anymore
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.
Yup!
this page will be hidden and will not be indexed (https://github.com/testdriverai/cli/pull/405/files/c38dada7555f7f1edccf5eaba6bbca285f2f0ab5#diff-50bd76e1e2b56dd4d7722b0a2ae3cb2804eb4f18ae8a3b50f9b1f38e5dc51a11R6), I just kept it in case we resume doing locally again, we can just pick from here
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.
same as above
I think that |
c35e087
to
0fd44ff
Compare
No description provided.