Skip to content

CLI Reference section#1336

Merged
dOrgJelli merged 12 commits into
origin-0.10-devfrom
pileks/chore/cli-docs
Nov 2, 2022
Merged

CLI Reference section#1336
dOrgJelli merged 12 commits into
origin-0.10-devfrom
pileks/chore/cli-docs

Conversation

@pileks
Copy link
Copy Markdown
Contributor

@pileks pileks commented Oct 17, 2022

Remaining work:

  • expand run command / get feedback from owner ( @Niraj-Kamdar )
  • expand infra command / get feedback from owner
  • expand deploy command / get feedback from owner
  • expand on codegen's -s, --script option Seems relatively unused and not documented elsewhere - can do as a separate PR if need be.
  • generally expand on the -c, --client-config option Wherever it’s needed, has links to the explanation

@pileks pileks requested a review from krisbitney October 17, 2022 10:00
@pileks pileks linked an issue Oct 17, 2022 that may be closed by this pull request
@pileks pileks changed the title CLI README update CLI Reference section Oct 17, 2022
@pileks pileks changed the base branch from origin to origin-0.10-dev October 20, 2022 20:35
@pileks pileks marked this pull request as ready for review October 25, 2022 10:22
Comment thread packages/cli/README.md
Comment thread packages/cli/README.md Outdated
Comment thread packages/cli/README.md Outdated
Comment thread packages/cli/README.md
Specify ids of jobs that you want to run

#### The Test manifest (`polywrap.test.yaml`)
Basic structure:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have mixed feelings because this is super cool, but in other commands when it comes to manifest we redirect users to documentation - Should that happen here too?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I agree that this would be much better suited to live within the docs repo.

Now that I look at it, https://docs.polywrap.io/quick-start/workflows/running-workflows seems outdated. Maybe rename it to Runnning tests and update with information found here.

What do you think?
CC @dOrgJelli @krisbitney

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

That's a good idea. I think it should also be added to the manifest package readme so we can prepare for the future when our reference documentation is created by copying the readmes into the docs

@cbrzn
Copy link
Copy Markdown
Contributor

cbrzn commented Oct 27, 2022

Should we add an example of how a custom client config file looks like? Usually, I would go to test-cases but would be cool if the dev, when reading this for the first time, have an idea of how to do things? Just thinking out loud feel free to ignore this hehe

@pileks
Copy link
Copy Markdown
Contributor Author

pileks commented Oct 27, 2022

That was my thought initially too, but then I linked to a few places with the custom client config.

Now that you commented the same thing, I think I could add it where it belongs.

Maybe a separate "Custom client config" mini-section, with the various options linking to it.

@dOrgJelli dOrgJelli merged commit cbe9014 into origin-0.10-dev Nov 2, 2022
@dOrgJelli dOrgJelli deleted the pileks/chore/cli-docs branch April 10, 2023 17:02
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.

Polywrap CLI Reference Section

4 participants