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

docs: add svg converted png in docs for workaround pdf conversion issued from imagemagik #2751

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lizable
Copy link
Contributor

@lizable lizable commented Aug 21, 2024

TL;DR

Updated image formats from SVG to PNG and added new icons for the documentation.

What changed?

  • Converted several diagrams from SVG to PNG format, including server architecture, vfolder concepts, development setup, and run state diagrams.
  • Added new icon images for various UI elements (e.g., arrows, social media icons, search).
  • Included a new Backend.AI logo image.
  • Updated references in RST files to point to the new PNG images instead of SVG files.

How to test?

  1. Navigate to the documentation pages where diagrams are used.
  2. Verify that all diagrams are displayed correctly in PNG format.
  3. Check that the new icons appear properly in the documentation UI.
  4. Ensure that the Backend.AI logo is visible and correctly formatted.

Why make this change?

This change improves compatibility and consistency across different browsers and devices. PNG format offers better support and rendering consistency compared to SVG, especially for complex diagrams. The addition of new icons enhances the visual appeal and usability of the documentation interface.


Checklist: (if applicable)

  • Milestone metadata specifying the target backport version
  • Mention to the original issue
  • Installer updates including:
    • Fixtures for db schema changes
    • New mandatory config options
  • Update of end-to-end CLI integration tests in ai.backend.test
  • API server-client counterparts (e.g., manager API -> client SDK)
  • Test case(s) to:
    • Demonstrate the difference of before/after
    • Demonstrate the flow of abstract/conceptual models with a concrete implementation
  • Documentation
    • Contents in the docs directory
    • docstrings in public interfaces and type annotations

📚 Documentation preview 📚: https://sorna--2751.org.readthedocs.build/en/2751/


📚 Documentation preview 📚: https://sorna-ko--2751.org.readthedocs.build/ko/2751/

Copy link
Contributor Author

lizable commented Aug 21, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @lizable and the rest of your teammates on Graphite Graphite

@github-actions github-actions bot added area:docs Documentations size:S 10~30 LoC labels Aug 21, 2024
@lizable lizable requested a review from Yaminyam August 21, 2024 09:19
@lizable lizable marked this pull request as ready for review August 21, 2024 09:19
@lizable lizable added this to the 24.03 milestone Aug 21, 2024
@kyujin-cho kyujin-cho marked this pull request as draft September 4, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Documentations size:S 10~30 LoC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant