Code Monkey home page Code Monkey logo

irods-development's Introduction

irods-development's People

Contributors

d-w-moore avatar

Watchers

James Cloos avatar  avatar

irods-development's Issues

Beginning / Setup and docker

In section Chapter 1 - Setup, instead of instructing users to use apt to install docker, a better approach would be to direct them to official documentation for installing docker. This leaves the decision up to the user for how they wish to install it and they are likely guaranteed to install the latest stable version instead of a version from the apt repo that may be old and performs differently than what is expected by your iRODS specific documentation.

An alternative to this is that you could document what version of docker the documentation is using. That would give users a minimum version for what they need to reproduce what is presented.

Ultimately, your documentation is not responsible for telling users how to meet all prerequisites. In my opinion, there is adequate documentation for setting up external tools and therefore we should leverage that documentation (when we can) and maybe provide direct links to the steps within that documentation to expedite and simplify setup.

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.