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

Inconsistency in referring images #111

Closed
ritik-malik opened this issue Mar 27, 2021 · 7 comments
Closed

Inconsistency in referring images #111

ritik-malik opened this issue Mar 27, 2021 · 7 comments

Comments

@ritik-malik
Copy link
Member

Hi,
I saw that the images in this repository are being referred differently in different markdown files.
A good example would be the directory : focus-areas/when
The following metric markdowns refer to images as:

Since there is already an attempt to bring all WG in same structure (doc), can we start by deciding a common way for referring the images...

Also, there is an error in mapping the metric from README, I tried to fix that in PR #109

@GeorgLink
Copy link
Member

Thank you for spotting this inconsistency.

We want to use Markdown with relative links, like seen in Time to Close:

![Average and median time to close an Issue from GrimoireLab](images/time-to-close.png)  

Absolute paths, full URLS, and HTML <img> tags should be converted

@sgoggins
Copy link
Member

sgoggins commented Apr 1, 2021

@klumb : Does using markdown relative references require a different set of actions from you than providing a full link to the http:// version of the visualization?

@germonprez
Copy link
Contributor

Sounds like every WG should have an:

'images' folder within each Focus Area

@sgoggins
Copy link
Member

sgoggins commented Apr 1, 2021

@GeorgLink Indicates using markdown relative links does not affect web deployment, and we recommend this be adopted as the standard for image referral.

@klumb
Copy link
Member

klumb commented Apr 1, 2021

There is some inconsistency in how this has been done. Relative paths often break on the website, however, there are instances where they have worked in the past. I haven't looked specifically at what folder/file structure works on the website with relative path links.

Absolute paths always work on the website.

@GeorgLink
Copy link
Member

Relative paths for images require to start with images/ and never with ./ -- if followed, this will work.

@GeorgLink
Copy link
Member

The PR #112 was merged. Issue can be closed

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

No branches or pull requests

5 participants