-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
PlantUML diagrams #8712
PlantUML diagrams #8712
Conversation
Documentation updates
Could we put those diagram files under a |
The diagrams have been moved to Let me know what you think |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AmauryM this looks good to me now. Want to take another look.
@hjorthjort is this good to merge? I see you doing extra work here and there
oh whoops, this was premature. this broke docker builds, I will open a PR to fix it |
We should make this test required imo |
weird it's not. |
Just noticed this PR broke the docs build on |
Thanks @lovincyrus |
huh? ci is showing it builds correctly. https://github.com/cosmos/cosmos-sdk/tree/gh-pages has been pushed to, ci seems to be working. if it broke the build of the docs, then we need a way to check this. I havent stepped in the docs deployment world in a while. I can take a look tomorrow. |
@@ -13,7 +13,7 @@ | |||
FROM golang:alpine AS build-env | |||
|
|||
# Install minimum necessary dependencies, | |||
ENV PACKAGES curl make git libc-dev bash gcc linux-headers eudev-dev python3 | |||
ENV PACKAGES curl make git libc-dev bash gcc linux-headers eudev-dev python3 plantuml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hjorthjort could you add a way to generate the plantuml? This is incorrect
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marbar3778 Can you elaborate on "a way to generate the plantuml"? We need a plantuml binary to generate diagrams. By far the least hairy way would be to install it as a package from the standard package manager. Is it not available?
The other options are building it from source (hairier) or committing the official .jar
directly, which would not stay up to date. The .jar
option might be best if we can't install the package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option would be to do something like this: https://github.com/miy4/docker-plantuml/blob/master/Dockerfile
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems you were trying to generate the uml files for useage in docs. This was failing because there is no uml binary. Is it okay we just dont generated the uml files into something that can be rendered?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's also possible to just generate the files locally (by anyone who has plantuml) and we simply commit the files. Not having them in the docs at all seems like a big step back, they are there to clarify things and there seemed to be a lot of positive feedback on having them.
But it's up to you what you think is the most hygenic approach.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can generate them locally and push them. Could you do this? I dont see us changing these files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay. can you update your open PR to remove the plantuml from the Dockerfile and remove (instead of commenting out) the line for generating them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be solved by #9124 (comment)
bump! |
Pushed a fix here → #9124 |
|
Description
Sequence diagrams describing different aspects of staking, and a diagram describing the dependencies of keepers (seen from the object capability model).
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
)godoc
comments.Unreleased
section inCHANGELOG.md
Files changed
in the Github PR explorerCodecov Report
in the comment section below once CI passes