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

EIP #88

Closed
theavege opened this issue Feb 5, 2024 · 7 comments
Closed

EIP #88

theavege opened this issue Feb 5, 2024 · 7 comments

Comments

@theavege
Copy link
Contributor

theavege commented Feb 5, 2024

Please include to stdlib EIP

@arnaudroques
Copy link
Contributor

arnaudroques commented Feb 5, 2024

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
Copy link
Contributor Author

theavege commented Feb 6, 2024

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

@The-Lum
Copy link
Collaborator

The-Lum commented Feb 6, 2024

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 theavege mentioned this issue Feb 6, 2024
@theavege
Copy link
Contributor Author

theavege commented Feb 6, 2024

I did

@theavege
Copy link
Contributor Author

theavege commented Feb 6, 2024

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

arnaudroques added a commit to plantuml/plantuml that referenced this issue Feb 6, 2024
@arnaudroques
Copy link
Contributor

It is online now :-)

@The-Lum
Copy link
Collaborator

The-Lum commented Feb 7, 2024

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.

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

No branches or pull requests

3 participants