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

chore(docs): add comment about prefect CLI needing to be on 3.0.0rc1 or later #243

Merged
merged 3 commits into from
Aug 14, 2024

Conversation

parkedwards
Copy link
Contributor

resolves #239

@@ -74,9 +74,11 @@ func (r *BlockResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
"`block` resources represent configurations for schemas for all different Block types. " +
"Because of the polymorphic nature of Blocks, you should utilize the `prefect` [CLI](https://docs.prefect.io/latest/getting-started/installation/) to inspect all Block types and schemas." +
"\n" +
"Use `prefect block types ls` to view all available Block type slugs, which is used in the `type_slug` attribute." +
"*Note:* you should be on version `3.0.0rc1` or later to use the following commands:" +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess technically 3.0.0rc1 is only required for the "data schema for a given Block type" portion below, and isn't really a requirement for just prefect block type ls - but that might be splitting hairs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hahah right. it started to become a mouthful, so i just glossed over some of the details

@github-actions github-actions bot added the docs label Aug 14, 2024
@parkedwards parkedwards merged commit 5f00182 into main Aug 14, 2024
5 of 7 checks passed
@parkedwards parkedwards deleted the chore/add-cli-docs branch August 14, 2024 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

prefect block types inspect not working
2 participants