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.

Sign up for GitHub

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

Jump to bottom

docs: uml hotfix #9124

Merged
merged 6 commits into from
Apr 16, 2021
Merged

docs: uml hotfix #9124

merged 6 commits into from
Apr 16, 2021

Conversation

lovincyrus
Copy link
Contributor

@lovincyrus lovincyrus commented Apr 15, 2021 •
edited
Loading

supersedes #9123
closes https://github.com/allinbits/design/issues/415

  • comment out ungenerated uml .svg in the md files
  • fix svgs referenced in x folder

Thanks for your contribution @hjorthjort . I'm sure the docs will look great with PlantUML diagram 😃 → #8712

By commenting out the generation of .svg file with .puml, that didn't really get the docs building. → #9121 @marbar3778

I propose that we revert it to a working docs.cosmos.network/master before adding any enhancement.

What caused it:

  1. pre.sh - plantuml -tsvg uml/*.puml
  2. When the script didn't convert the .puml into .svg, the mentioned ![](../uml/transaction_flow.svg) in the .md files wouldn't be able to process it.

image

After commenting out pre.sh and the svgs:
image

To prevent this from happening:

What's next?

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.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@lovincyrus lovincyrus added the T:Docs Changes and features related to documentation. label Apr 15, 2021
@lovincyrus
generate svgs to docs/uml
00803e1 
* create docs/uml/svg
* move .punl to docs/uml/puml
* update uml path in md files
@lovincyrus
Copy link
Contributor Author

lovincyrus commented Apr 15, 2021 •
edited
Loading

00803e1

  • Found an online uml texteditor https://www.planttext.com
  • Converted our .puml files in the uml folder
  • Moved them to svg folder
  • Updated the path ![](../uml/transaction_flow.svg) → ![](../uml/svg/transaction_flow.svg)
  • Updated the relative path in x folder

image
image
image

And it builds successfully.

image

This was referenced Apr 15, 2021
Merged
Merged
@lovincyrus lovincyrus marked this pull request as draft April 15, 2021 20:06
@lovincyrus lovincyrus marked this pull request as ready for review April 15, 2021 21:23
@tac0turtle tac0turtle merged commit 89cb9b0 into master Apr 16, 2021
@tac0turtle tac0turtle deleted the cyrus/docs-hotfix branch April 16, 2021 07:59
@tac0turtle tac0turtle mentioned this pull request Apr 16, 2021
Closed
9 tasks
@hjorthjort hjorthjort mentioned this pull request Apr 16, 2021
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@aaronc aaronc Awaiting requested review from aaronc

@alessio alessio Awaiting requested review from alessio

@alexanderbez alexanderbez Awaiting requested review from alexanderbez

Assignees
No one assigned
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lovincyrus @tac0turtle