Code Monkey home page Code Monkey logo

docs.bacalhau.org's Introduction

Bacalhau Docs

This repository manages the documentation for the Bacalhau Project. This repo also contains the build scripts and tools to create and contribute to the Bacalhau docs website. Explore the docs →

Table of contents

Develop docs locally

Follow these simple example steps to get a local version of the site up and running.

Prerequisites

Installation

git clone https://github.com/bacalhau-project/docs.bacalhau.org.git
cd docs.bacalhau.org/
npm install

Render website

npm run start

The rendered site will be accessible at http://localhost:3000/

Documentatation structure

docs/ : This is where all the .md files live that control the content of this site. Most contributions happen in this directory.

Note: All code examples live in a dedicated repository https://github.com/bacalhau-project/examples and they are automagically rendered into the ./docs/examples/ folder by github actions.

Contributing

We would love ❤️ your help to improve existing items or make new ones even better!

Issues and Pull requests

If you find any inconsistencies in the docs, please raise an issue here →. Feel free to also submit a pull request with any changes you'd like to see to this repo. Every contribution is more than welcome! 🎈

Be Part of the community

If you have any questions you can join our Slack Community go to #bacalhau channel - its open to anyone!

Resources

docs.bacalhau.org's People

Contributors

2color avatar aronchick avatar binocarlos avatar bmann avatar developerally avatar enoldev avatar enricorotundo avatar fakela avatar frrist avatar it09 avatar joshklop avatar js-ts avatar kbtombul avatar kelindi avatar laurahohmann avatar lukemarsden avatar lynergy avatar pedrobyjoao avatar philwinder avatar rossjones avatar sa8 avatar simonwo avatar walkerlj0 avatar wdbaruni avatar wesfloyd avatar wildanvin avatar wjam avatar xandramcc avatar yanofearth avatar yenyrubiano avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs.bacalhau.org's Issues

Formatting/Rewording of Running Genomics on bacalhau page

page: https://docs.bacalhau.org/examples/miscellaneous/Genomics/
with your docker hub username, If you don’t have a docker hub account [Follow these instructions to create docker account](https://docs.docker.com/docker-id/), and use the username of the account you created

This is the name of the container, you can name it anything you want

This is not required but you can use the latest tag
→ fix formatting

  • Insalling bacalhau → typo and Bacalhau

  • Where it says "Published " → delete “”

  • #VIEWING THE OUTPUTS → formatting

  • Molecular Dynamics with Bacalhau

  • formatting of sections

  • Where it says "Completed "→ delete “”

Getting Started Improvements

Problem Statement: Users who are new to Bacalhau and what it does need more context and walk through of the experience with doing some basic tasks with the CLI

Suggested Solution: See the PR here for suggestions

To-Dos

  • Check how verbose output is after docker container run- Screen Shot 2022-09-08 at 1 43 39 PM
  • audit step where job ID is grabbed from process ID - Screen Shot 2022-09-08 at 2 00 11 PMScreen Shot 2022-09-08 at 1 43 39 PM
  • Add more context as indicated in PR above

Review CLI command docs

  • It would be also awesome to have the spec closer to Kubernetes/Kamu in terms of syntax.
  • Keys in the YAML format have mixed case, which is confusing and odd to read

fix capitalization in our yaml

Right now our yaml format uses a mix of upper and lowercase words. It should use lowercase camelCase like k8s yaml does.

Changes needed

An example yaml in the docs of input folders (in the create command, above) as well as outputs.

What is needed

  • An example of input folders (for Favour to work on) so i can add that example to the docs
  • the actual code needs to parse yaml files that don’t have capitalization all over the place, we want it to look like k8s yamls

https://docs.bacalhau.org/all-flags#create

bacalhau-project/bacalhau#1652

error reproducing https://docs.bacalhau.org/demos/image-processing using zsh

Hi COD team - we are currently working to use the tools extensively for scientific compute tasks within LabDAO.

I am currently working through some examples and creating tutorials internally. I noticed that the example below throws an error in zsh (I am running hyper on an M1 Mac).

bacalhau docker run \
  -v QmeZRGhe4PmjctYVSVHuEiA9oSXnqmYa4kQubSHgWbjv72:/input_images \
  -o results:/output_images \
  dpokidov/imagemagick \
  -- magick mogrify -resize 100x100 -quality 100 -path /output_images /input_images/*.jpg

The error is related to the * wildcard in the prompt:

rindtorff@niklas ~ % bacalhau docker run \
  -v QmeZRGhe4PmjctYVSVHuEiA9oSXnqmYa4kQubSHgWbjv72:/input_images \
  -o results:/output_images \
  dpokidov/imagemagick \
  -- magick mogrify -resize 100x100 -quality 100 -path /output_images /input_images/*.jpg
zsh: no matches found: /input_images/*.jpg

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.