[epic] Docs tasks for the Plugin Development Guide

[t-kikuc]

What would you like to be added:

This issue tracks tasks of documentation of the guide for developing a plugin. When a new task or PR emerges, please add/link it to this Issue.

Why is this needed:

• To tell developers how to develop a plugin

See also

• User guide: https://github.com/pipe-cd/pipecd/issues/5615
• This may be related to: https://github.com/pipe-cd/pipecd/discussions/5820

Tasks

• [ ] usage of the SDK/API
• [ ] Example plugins
  • [x] only stages
  • [ ] deployment (including livestate)
• [ ] test/build
• [ ] documentation of configuration, etc.
• [ ] (and ...)

[t-kikuc]

We should determine where to write them at first.

[t-kikuc]

We should determine where to write them at first.

There are three candidates as follows. I think [A] seems the best for now, and [B] is secondary.

• A. /devguide/plugin dir
  • Pros:
    • simple
    • sync with the head code
  • Cons:
    • The review policy might be heavy
• B. a new repo
  • Pros:
    • Reviewing is lighter, which leads to more information with examples and tips
    • The main repo is lighter
  • Cons:
    • It would not be synced with the head codebase
• C. /docs/<SOME_DIR> dir
  • Cons: dev guide is different from the docs, which is mainly for users, and is to be hosted

Note: There might be a developer guide for not only plugins. https://github.com/pipe-cd/pipecd/discussions/4924

WDYT?

[t-kikuc]

cf. Docs Advisor

https://github.com/google/opendocs/blob/main/docs_advisor/README.md

[t-kikuc]

C. /docs/<SOME_DIR> dir Cons: dev guide is different from the docs, which is mainly for users, and is to be hosted

That was wrong.

C is better because docs/ can contain non-user docs like RFCs

[eeshaanSA]

Any help needed with this issue? I can get my hands in!