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

Update Docs and Readme #346

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

thekamilpro
Copy link
Contributor

Description of the Change

Add description for -MaxLength parameter.
Add instructions on how to build pode.web on Windows.

Related Issue

n/a

Additional Context

It took me some time to build the module for the first time - I needed read pipeline definition to find out which modules are being used, then how to get yarn etc. I hope this little guide would hopefully encourage more people to contribute.

@thekamilpro
Copy link
Contributor Author

Added one more change for Table examples - the Start-Service button was configured to use -Force parameter, which doesn't exist for this cmdlet (I KNOW!), failing for example to execute action for the button.

@Badgerati
Copy link
Owner

Aah, for the Build Dependencies it might be worth updating the .build.ps1 file to install the dependencies. They're there for making the docs, but I didn't setup Build the same ; it using choco to do the install there - even installs choco if missing - and has some support for *nix systems.

If you'd like the tackle it, the task DocsDeps is an example of how it works, and Pode has the same setup :)

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