singularityhub / sregistry

server for storage and management of singularity images
https://singularityhub.github.io/sregistry
Mozilla Public License 2.0
103 stars 42 forks source link

Small documentation fixes #419

Closed SethosII closed 1 year ago

SethosII commented 1 year ago

Fix documentation errors mentioned in https://github.com/singularityhub/sregistry/issues/416#issuecomment-1485078104.

vsoch commented 1 year ago

The path to ldap.png is correct. If it's not showing up you could try adding site.baseurl or similar to get the full path, although then it won't render in the markdown.

SethosII commented 1 year ago

@vsoch For me it looks like this in Firefox/Chrome/Edge: ldap_image_broken

I use this way to include images in my Jekyll sites: /sregistry/docs/plugins/ldap/ldap.png but other images in the repository use something like this for the paths: ../../assets/img/bitbucket-consumer.png.

By the way, should the ldap image also be in assets/img?

vsoch commented 1 year ago

If that works for the other images, moving it there should be a good idea! 👍

SethosII commented 1 year ago

@vsoch I also changed it for the images of the globus page.

vsoch commented 1 year ago

Did you run locally to confirm they are all visible? That's the last check I'd do - once you confirm that we can merge I think!

SethosII commented 1 year ago

@vsoch I checked it locally and it works.

However, while trying to set it up locally I couldn't use jekyll coming with Ubuntu because the gems installed with it where to new and when using jekyll from the bundle installed by the Gemfile in the repository I had to manually install webrick and there was a warning about sass?? So the full list of commands to get it to work was like that:

> cd sregistry/docs
> sudo apt purge --autoremove jekyll
> sudo apt install ruby-dev ruby-bundler
> bundle install
# returned this error:
Downloading sass-3.7.4 revealed dependencies not in the API or the lockfile (sass-listen (~> 4.0.0)).
Either installing with `--full-index` or running `bundle update sass` should fix the problem.
# bundle install --full-index returned the same error
> bundle update sass
# returned this warning at the end:
Post-install message from sass:

Ruby Sass has reached end-of-life and should no longer be used.

* If you use Sass as a command-line tool, we recommend using Dart Sass, the new
  primary implementation: https://sass-lang.com/install

* If you use Sass as a plug-in for a Ruby web framework, we recommend using the
  sassc gem: https://github.com/sass/sassc-ruby#readme

* For more details, please refer to the Sass blog:
  https://sass-lang.com/blog/posts/7828841
> jekyll serve
# returned this error:
/var/lib/gems/3.0.0/gems/jekyll-3.9.3/lib/jekyll/commands/serve/servlet.rb:3:in `require': cannot load such file -- webrick (LoadError)
> bundle add webrick
> jekyll serve
# and finally it works
vsoch commented 1 year ago

@SethosII I usually use jekyll from rb-env (and I haven't installed for a while) so I suspect the install might vary. If it was hard /annoying enough and you want to tweak the docs please feel free to open another PR, but it's not required!