Pdk preview docs #223
Pdk preview docs #223
Conversation
docs/pdk.md
Outdated
| 1. [Generate a module](./pdk_generating_modules.md) using the `pdk new module` command. | ||
| 1. [Validate your module](./pdk_testing.md), to verify that it is well-formed. | ||
| 1. [Unit test](./pdk_testing.md) your module, to verify that all dependencies and directories are present. | ||
| 1. [Generate a class]](./pdk_generating_modules.md) for your module, using the `pdk new class` command. |
There was a problem hiding this comment.
Extra ] here, also should the link be to ./pdk_generating_modules.md#generate-a-new-class
There was a problem hiding this comment.
I added more specific links to all these.
docs/pdk_generating_modules.md
Outdated
|
|
||
| 1. From the command line, run the `pdk new module` command, specifying the name of the module: `pdk new module module_name` | ||
|
|
||
| Optionally, to skip the interview questions and generate the module with default values, use the ``skip-interview` flag when you generate the module: `pdk new module module_name --skip-interview` |
docs/pdk_generating_modules.md
Outdated
| 7. Where others can learn more: If you have a website where users can learn more about your module, enter the URL. | ||
| 8. Where others can report issues: If you have a public bug tracker for your module, enter the URL. | ||
|
|
||
| 1. If the metadata that PDK displays is correct, confirm to generate the module. If it is incorrect, enter `n` to cancel and start over. |
There was a problem hiding this comment.
Should confirm to generate the module indicate hitting the Enter key or typing y and then Enter?
There was a problem hiding this comment.
I was thinking about this, but it also says what to do right in the interface. That said, I can add it though, I think it seems OK with it too.
|
Updated with respect to @bmjen 's comments. |
docs/pdk_reference.md
Outdated
| Argument | Description | Values | Default | ||
| ----------------|:---------------:|:------------------:|------------------------- | ||
| `--template-url=git_url` | Overrides the template to use for this module. | A valid Git URL. | No default. | ||
| `--license=spdx_identifier` | Specifies the license this module is written under. | See https://spdx.org/licenses/ for a list of open source licenses, or use `proprietary`. | Apache 2.0 |
There was a problem hiding this comment.
Tiny nit but the default license value is Apache-2.0
There was a problem hiding this comment.
Good point, that - is actually rather important when it comes to linting and parsing on the Forge right?
There was a problem hiding this comment.
Yes, but the actual value in PDK seems correct.
There was a problem hiding this comment.
Yeah, legit, good catch @scotje
There was a problem hiding this comment.
Might be worth clarifying that they should use the "identifier" from that SPDX link.
chelnak
added
the
maintenance
These have a reworked structure that should be much better for what users actually want to do with PDK. See pdk.md for the overview / getting started.