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

Update readmes #46

Merged
merged 14 commits into from
Apr 19, 2023
Merged

Update readmes #46

merged 14 commits into from
Apr 19, 2023

Conversation

gberl002
Copy link
Contributor

No description provided.

@gberl002 gberl002 requested a review from a team as a code owner April 12, 2023 19:07

## Installation
# Python SDK for OpenZiti
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this HTML?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely would prefer to see this as markdown. sometimes for images you really need to embed html on the markdown so that you can style an image but most of what I see here should be markdown, not html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To get the styling that I wanted (a lot of it simply centering and/or centering inline content), I had to use HTML to get it to work how I wanted. Much of the HTML structure is copied from other READMEs that I drew inspiration from, and I did remove HTML from the copied content wherever possible.

I can revisit the HTML and try to make more of it work as markdown, but it was similar to this image. After a decent amount of effort, I couldn't get the markdown to do what I wanted, and it easily worked as HTML, so I didn't want to waste more time trying to get it to work when it may not have even been possible and worked as is.
image

@ekoby ekoby merged commit a1e0411 into main Apr 19, 2023
@ekoby ekoby deleted the update_readmes branch April 19, 2023 13:29
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

Successfully merging this pull request may close these issues.

3 participants