Giter Site home page Giter Site logo

documentation link in repo? about singularity HOT 7 CLOSED

sylabs avatar sylabs commented on May 22, 2024
documentation link in repo?

from singularity.

Comments (7)

dtrudg avatar dtrudg commented on May 22, 2024 1

Courtesy of @wobito the linked page now looks like this:
image

from singularity.

dtrudg avatar dtrudg commented on May 22, 2024

Hi @vsoch - the docs from sylabs/singularity-userdocs and sylabs/singularity-admindocs aren't on read the docs... at least we aren't putting them there (have you found them somewhere?). The links in the README.md on the repo should currently go to the correct sylabs.io URL that will get you to a place with the latest docs for the current stable version.

The latest master version of the docs repos are built in CI to a CircleCI artefact, but unfortunately CircleCI doesn't have a nice way to link to that with a static URL. We do need a better way of exposing those, and will look into that.

from singularity.

dtrudg avatar dtrudg commented on May 22, 2024

This is what the README.md shows now... so we do have links to the guides, and we do mention and link to the repos for the user guide and admin guide...

image

If there's better wording that could be used here we would appreciate a PR.

from singularity.

vsoch avatar vsoch commented on May 22, 2024

Sorry got the wrong place it's deployed (not read the docs).

I don't mean the README, I would like to see the user docs linked here:

image

It's the first place that I look when I arrive at the repo (and my own repos, and other repos) and would be great to have there! I can't PR to update that, it requires repo write permission.

from singularity.

dtrudg avatar dtrudg commented on May 22, 2024

Ahh okay - let me see if I can do that!

from singularity.

dtrudg avatar dtrudg commented on May 22, 2024

Can only set one link - unfortunately others can't be added to the description text.

I'll talk to @wobito and we'll get mention of the repositories on the page it links to.

image

from singularity.

vsoch avatar vsoch commented on May 22, 2024

That looks great, thank you! We can keep this issue open to track that, or if it's underway feel free to close.

from singularity.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.