pdk icon indicating copy to clipboard operation
pdk copied to clipboard

[docs] Workflow graph is likely wrong

Open bittner opened this issue 5 years ago • 5 comments

Describe the bug There is a "PDK development workflow" info graphic in the PDK documentation, which depicts the PDK commands and suggests an order, a flow of tasks, to apply them.

The "Add your own code" and "Test & Iterate" boxes are outside of the grayish background "pdk commands" box. This is likely not fully correct, since "Test & Iterate" entails running pdk validate and pdk test unit.

To Reproduce

  1. Go to https://puppet.com/docs/pdk/1.x/pdk_overview.html#pdk-development-workflow
  2. Look at the "PDK development workflow" info graphic

Expected behavior The info graph should show the following order / workflow instead:

                                                                       |
                      +----------------------+                         |
+----------------+    | pdk new class        |    +---------------+    |     +----------+
| pdk new module | -> | pdk new defined_type | -> | pdk validate  | ---|---> | Add your |
+----------------+    | pdf new task         | <- | pdk test unit |    |     | own code |
                  ->  +----------------------+    +---------------+    |     +----------+
+-------------+  /                                       ^             |           |
| pdk convert | /                                        +-------------|-----------+
+-------------+                                                        |

The "Add your own code" box should be the only one outside of the grayish background "pdk commands" box.

Additional context This is all about the content of the Puppet.com website.

bittner avatar Jun 26 '20 11:06 bittner

This issue has been marked stale because it is open with no recent activity. The PDK Team is actively prioritizing existing bugs and new features, if this issue is still important to you please comment and we will add this to our backlog to complete.

github-actions[bot] avatar Aug 26 '21 01:08 github-actions[bot]

Could maybe someone from the Puppet website team take a look at this issue?

bittner avatar Aug 26 '21 08:08 bittner

This issue has been marked stale because it is open with no recent activity. The PDK Team is actively prioritizing existing bugs and new features, if this issue is still important to you please comment and we will add this to our backlog to complete.

github-actions[bot] avatar Feb 23 '22 01:02 github-actions[bot]

Could maybe someone from the Puppet website team take a look at this issue?

bittner avatar Feb 23 '22 07:02 bittner

This issue has been marked stale because it is open with no recent activity. The PDK Team is actively prioritizing existing bugs and new features, if this issue is still important to you please comment and we will add this to our backlog to complete.

github-actions[bot] avatar Aug 23 '22 02:08 github-actions[bot]

@bittner we can take a look at this for you!

chelnak avatar Feb 15 '23 12:02 chelnak

Great! Took almost 3 years, but, yeah, never lose hope. :crossed_fingers:

I hope the workflow is still correct. I'm only starting to use Puppet again, so not yet up-to-date with the latest advancements at Puppet.

bittner avatar Feb 16 '23 11:02 bittner

Looks like this has been updated: https://www.puppet.com/docs/pdk/3.x/pdk_overview.html#pdk-development-workflow

david22swan avatar Sep 06 '23 09:09 david22swan