Skip to content

[MISC] rename logo files, add a README of where they come from, fix favicon#249

Merged
sappelhoff merged 8 commits intobids-standard:masterfrom
sappelhoff:addinfo
Jun 25, 2019
Merged

[MISC] rename logo files, add a README of where they come from, fix favicon#249
sappelhoff merged 8 commits intobids-standard:masterfrom
sappelhoff:addinfo

Conversation

@sappelhoff
Copy link
Copy Markdown
Member

@sappelhoff sappelhoff commented Jun 21, 2019

related to #244

@franklin-feingold we have two PNG images with transparent background ... however, one of them is cropped and the other is not - could you provide the cropped version of the "white" edition to replace the non-cropped file?

Or was there some reason to it?

Also note that I ...

  • renamed the files for consistency
  • renamed the directory to not have whitespace
  • made an attempt to fix the favicon path
  • added our Logo to the main README ... it will look like this (coooooool 🎉 )

@sappelhoff
Copy link
Copy Markdown
Member Author

The favicon does not seem to work yet ... But I think through #250 I got an idea how to solve it (place the favicon in /theme_customizations and point to it from mkdocs.yml)

This PR can still be merged after the potential enhancement through Franklin's provision of the cropped file (see original post)

@franklin-feingold
Copy link
Copy Markdown
Collaborator

Thank you for looking into this! Opened a PR (https://github.com/sappelhoff/bids-specification/pull/10) to add the crop and remove the not-cropped white logo.

Regarding the favicon enhancement - the theme we are using to render the readthedocs (material) provided a very short summary of how to customize the favicon (https://squidfunk.github.io/mkdocs-material/getting-started/#favicon). I also looked at another repo that did successfully (https://github.com/opensciencegrid/technology/blob/master/mkdocs.yml), interesting that removing the spaces didn't render it.

@sappelhoff
Copy link
Copy Markdown
Member Author

Regarding the favicon enhancement - the theme we are using to render the readthedocs (material) provided a very short summary of how to customize the favicon (https://squidfunk.github.io/mkdocs-material/getting-started/#favicon). I also looked at another repo that did successfully (https://github.com/opensciencegrid/technology/blob/master/mkdocs.yml), interesting that removing the spaces didn't render it.

yes, the image is on the wrong path ... we expect Mkdocs-material to be searching for 'BIDS_logo/favicon.ico' from the root of our repository ./ ... but it's using some other path 🤷‍♂

Once this PR is merged, I can rebase #250 and put the icon into the /theme_customizations directory under a path assets/images/favicon --> then it will replace the mkdocs-material default (see here)

@franklin-feingold
Copy link
Copy Markdown
Collaborator

that sounds good! has your fork rendered the favicon in the new path?

rwblair
rwblair previously approved these changes Jun 24, 2019
@sappelhoff
Copy link
Copy Markdown
Member Author

that sounds good! has your fork rendered the favicon in the new path?

I didn't try it yet, waiting for #250 to be merged first :-)

@sappelhoff
Copy link
Copy Markdown
Member Author

sappelhoff commented Jun 25, 2019

@sappelhoff sappelhoff merged commit dc6454c into bids-standard:master Jun 25, 2019
@sappelhoff sappelhoff deleted the addinfo branch June 25, 2019 12:54
@franklin-feingold
Copy link
Copy Markdown
Collaborator

appears something with this merge failed circle - https://circleci.com/gh/bids-standard/bids-specification/722

@sappelhoff
Copy link
Copy Markdown
Member Author

I assume it's a temporary issue having to do with a server response / internet connection:

This is the error:

/usr/local/bundle/gems/octokit-4.9.0/lib/octokit/response/raise_error.rb:16:in `on_complete': GET https://api.github.com/repos/bids-standard/bids-specification/issues/137/events?per_page=100: 502 - Server Error (Octokit::BadGateway)

I restarted the build, and now it passes: https://circleci.com/workflow-run/57dbb9e8-49e5-4f9d-a5d6-9f7b75cd9e5e

@franklin-feingold
Copy link
Copy Markdown
Collaborator

interesting - our badge is still failing, not sure why

@sappelhoff
Copy link
Copy Markdown
Member Author

takes some time to update, I guess :-)

all green now:
image

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