plantuml/plantuml-stdlib

EIP

theavege opened this issue · 7 comments

theavege commented

Please include to stdlib EIP

arnaudroques commented

It would help if you could propose a PR here with files from https://github.com/plantuml-stdlib/EIP-PlantUML
Do you know how to do that?
Thanks!
PS: Edited with right URL :-)

theavege commented

Sorry. I don't know how to do that. Do you have instructions?

  • 👀1
The-Lum commented

Hi @theavege, and all,

Do you have instructions?

See some elements here:

And here's a quick detailed procedure:

  1. Fork plantuml/plantuml-stdlib and then git clone
  2. Create a new branch (the name is full open, no constrains) like new_lib, add/EIP or update/EIP, or add_EIP or update_EIP
  3. Create a new folder eip [for the EIP Library] (preferably on lowercase: only C4 and DomainStory have uppercase!) on your branch created on (2)
  4. Copy only final folder/files (not input files [e.g. folder scripts or test are no needed])
  5. Create an INFO file as described on CONTRIBUTING on plantuml/plantuml-stdlib
VERSION=1.0.0
SOURCE=https://github.com/plantuml-stdlib/EIP-PlantUML
  1. Make changes to the README.md file to add the EIP Library and describe it.
  2. Commit your work and push it up to your fork repository
  3. Submit a Pull Request from your fork repository back to the main repository: submit a Pull Request to PlantUML team (plantuml/plantuml-stdlib) with your add/update.
  4. Wait Review and PR approval...

Then PlantUML Team and especially @arnaudroques:

  1. Accept your PR
  2. Transform and Compress the files of the new folder
  3. Make a commit with those files on plantuml/plantuml/stdlib
  4. Then your Library will be now packaged on plantuml.jar
  5. Enjoy... and share... 🎉

See also discussion about EIP Library here:

If that can help,
Regards,
Th.

theavege commented

@The-Lum , How to include my theme to puml-themes?

arnaudroques commented

It is online now :-)

  • 🎉2
The-Lum commented

Hello @theavege,

Now that the plantuml version contains the EIP library, here are some end actions of documentation...

On plantuml/plantuml-stdlib/README.md

  • Could you replace on the image source:
    • the currently !include https://raw.githubusercontent.com/plantuml-stdlib/EIP-PlantUML/main/dist/EIP-PlantUML.puml
    • by !include <eip/EIP-PlantUML>

On plantuml.com/stdlib

Through alphadoc/stdlib

  • Could you add documentation about EIP or copy doc. from the above item?

Thanks a lot.
Regards,
Th.