sugarlabs / sugar-docs

Documentation for Contributors and Developers
82 stars 103 forks source link

Fix: #130 Hello World Icon not being displayed #133

Closed rhl-bthr closed 6 years ago

rhl-bthr commented 6 years ago

Fixed in PR: 'Hello world Icon not being displayed'

130 is now completely resolved.

A partial fix was done in #131.

ghost commented 6 years ago

On Wed, Jan 03, 2018 at 03:46:35PM +0000, Rahul Bothra wrote:

Fixed in PR: 'Hello world Icon not being displayed'

130 is now completely resolved.

A partial fix was done in #131.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

You can view, comment on, or merge this pull request online at:

https://github.com/sugarlabs/sugar-docs/pull/133

Commit Summary

• Replace .svg with .png

File Changes

• M desktop-activity.md (4) • A images/activity-helloworld.png (0) • D images/activity-helloworld.svg (26)

Patch Links:

https://github.com/sugarlabs/sugar-docs/pull/133.patchhttps://github.com/sugarlabs/sugar-docs/pull/133.diff

You've made two changes:

You removed the newlines from the link, eg,

-![Activity
- Icon](images/activity-helloworld.svg
- "Activity icon")
+![Activity Icon](images/activity-helloworld.png "Activity icon")

as well as having changed only the the SRC (target) of the link from svg to png

Unfortunately, with regard to the latter, you changed the target, but not the descriptive text, so those are now inconsistent.

I'd suggest we first try just the removal of the whitespace.

If that does not work, then change svg --> png in both places.

rhl-bthr commented 6 years ago

This descriptive text:

activity/activity-helloworld.svg

is referring to the logo present in "helloWorld Activity's activity directory" and this shouldn't be changed Kindly correct me if I am wrong, or you were referring to something else.

quozl commented 6 years ago

What's the actual problem; why doesn't the SVG appear?

images/header-icon.svg is not referenced, yet remains in images.

rhl-bthr commented 6 years ago

What's the actual problem; why doesn't the SVG appear?

It could be either of the two:

  1. Due to the whitespaces(newline) in the image code (It works fine in Github Preview though)
    ![Activity
    Icon](images/activity-helloworld.svg
    "Activity icon")
  2. The service being used to build webpages from markdown files is unable to process .svg files (as suggested by @walterbender)

I am uncertain which one was it, as I was unable to build and test it locally (Issue: #132).

images/header-icon.svg is not referenced, yet remains in images.

I think its being used as the title of the website. Again, I am uncertain as I am unable to build it locally.

@quozl Kindly let me know if I should incorporate any changes.

quozl commented 6 years ago

Thanks. While I don't build it locally either, I did look more deeply at the regular-expressions used in the parser, and fixed it in commit 3d8e7f5d3d04a58078bba5f03286f7a6a7804fcb. Your help on #132 was essential.