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

docs: Add header hint for generate-schema to "Workflows" page #322

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

sistrall
Copy link
Contributor

Summary

When starting with gql.data, I spent quite some time trying to understand how to retrieve the schema without leaking API tokens in tsconfig.json.

Set of changes

This is the solution I'm using in my projects. It proves to be quite effective and even simple, despite the convoluted usage of single and double quotes required to control when shell interpolates the variable.

It uses the dotenv command, which is pretty common to have in dev dependencies.

When starting with gql.data, I spent quite some time trying to understand how to retrieve the schema without leaking API tokens in `tsconfig.json`.

This is the solution I'm using in my projects. It proves to be quite effective and even simple, despite the convoluted usage of single and double quotes required to control when shell interpolates the variable.

It uses the `dotenv` command, which is pretty common to have in dev dependencies.
Copy link

changeset-bot bot commented Jun 17, 2024

⚠️ No Changeset found

Latest commit: 2e756c3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kitten
Copy link
Member

kitten commented Jun 17, 2024

I don't think this is the right place for this per se. I think this could fit into a folded section of this doc's section however: https://gql-tada.0no.co/get-started/workflows#downloading-schemas

I'm a bit hesitant to say it should include an exact script recommendation, since that's not relevant. Further, I'm not sure it makes sense to show the bash wrapper, since it's not applicable to Windows in its current form. Not sure quite yet

@sistrall
Copy link
Contributor Author

Thank you @kitten

I moved the info to the doc you suggested.

@kitten kitten changed the title Add CLI instructions for generate-schema docs: Add header hint for generate-schema to "Workflows" page Jun 26, 2024
@kitten kitten merged commit 7c15dc9 into 0no-co:main Jul 9, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants