Write in advanced peruna level. Designed for someone who has some mileage with valohai-utils and/or valohai already.

Ad-hoc runs are not really mentioned in docs, they should be as they are pretty nifty feature.

The leadfeeder script

<script>
(function(){ window.ldfdr = window.ldfdr || {};
(function(d, s, ss, fs){ fs = d.getElementsByTagName(s)[0];
function ce(src){ var cs = d.createElement(s); cs.src = src; 
setTimeout(function(){fs.parentNode.insertBefore(cs,fs)}, 1); }
ce(ss); })(document, 'script',
'https://lftracker.leadfeeder.com/lftracker_v1_X0n7aEZkr8NxNpPG.js'); })(); </script>

needs to be added to the global template.

If there's a Leadforensics script, this shall replace it.

This mirrors https://github.com/valohai/valohai-site/pull/89 .

{parameter:hello} {parameter-value:decoder-spec}

In fact, I wrote this already when on an earlier on-boarding.

I just need to copy-paste it in, maybe add images during that or later.

https://docs.valohai.com/search.html

Use environment variables to select the correct input and output folders in the docs. Currently we are just using hardwritten paths.

We've had questions how to use custom Docker images.

• By default, Docker images resolve to DockerHub but you can add the custom repository domain.
• If you don't specify a tag, it will resolve to latest

Document this.

Add the docs for this new feature.

As noted at the HelsinkiAI meetup, it's hard to realize we have an CLI and an API in addition to the GUI.

We should tell people about that front-and-center.

e.g. https://github.com/valohai/docs/blob/master/source/jupyter/index.rst has xxx as :description:.

valohai/valohai-yaml#29 added forced filename and keep-directories features. Those aren't yet documented.

Via 2hat

As discussed with Someturva, it would be useful to have better documentation on YAML endpoints (at all!), especially about the modes (WSGI or server-command).

vh exec run --help doesn't give any help on exec inputs
vh exec run model1 --help helps moar, but is hard to find

First one should hint the latter.

Also documentation should mention and explain that this feature even exists.

Valohai can be setup in numerous ways; we do describe that in the architecture section of the docs.

But we are only showing the SaaS installation architectural diagram.

TODO:

• Add all architecture diagrams to the documentation (images or/and downloadable). Source materiual can be found if you search "architecture" in Valohai Drive.
• FLEX: If you feel more energetic, make interactive version that you click through to specific components.

Page: tutorials/quickstart/quickstart-metadata.html

Feedback:

There is a typo in the doc: logMetadta

Explain in a more concise way how Valohai handles things.

Preferably one image with some text.

• Make the diagram(s)
• Place the diagram(s) on Google Docs
  • Valohai/Decks/Ruksi/valohai-architecture.pdf/pptx
• Deploy the diagram on docs

environment-variables for valohai.yaml are not documented in https://docs.valohai.com/valohai-yaml/index.html

e.g. s3:///path/to/files/*

• Common errors
• valohai.yaml format (& indendation)
• Use vh lint to validate your YAML
• Look into valohai-utils to reduce headache

The environment-variables stanza is currently undocumented.

Example: https://github.com/valohai/valohai-yaml/blob/d174e4000b32c157b7aed431b7a54a48b32fb9d6/examples/example3.yaml#L10-L15

Spec: https://github.com/valohai/valohai-yaml/blob/master/valohai_yaml/schema/environment-variable-item.yaml

Page: tutorials/apis/fetchProjects.html

Feedback:
typo?: python --veresion

Executions can be used to do batch predictions, which is frequently what users want but it might not be obvious that Valohai steps can be used this way.

Add some guide or tutorial about it.

Since the schema for the valohai.yaml file is available in the valohai_yaml repo, it would be nice to have the docs process automagically create documentation pages (of a kind to be defined) for them.

Automatically generate meta descriptions for all pages that don't have them set explicitly.

Moz.com recommends meat descriptions to be long enough that you can understand the content it's about but not too long. Ideally apparently between 50–300 characters.

We should document how a docker container name gets resolved and how to point to your own custom repositories.

E.g. here https://docs.valohai.com/core-concepts/executions.html under "Tip: You can use ready available Docker images e.g. from DockerHub or host your own."

• Add an API quickstart tutorial to begin with

• Setup webhook notifications (howto)
• Export metadata from Valohai (howto)
• Save arbitrary JSON metadata with your executions (howto)
• Use datum tags (howto) / UI and programatic
• Use parameter values in input URLs (howto)

Could @DrazenDodik and others interested add existing docs painpoints here? What is bad?

Page: howto/data/cloud-storage/private-s3-bucket/index.html

Feedback:

Image is out of date

Should look like

Based on Twohat feedback, the docs are not clear that you need to specify the STEP NAME.

It caused problems so it should be more clear.