7
Functions - Documentation Needs Improvement
Gary Moon
The documentation for DO Functions needs a lot of attention. I built my first last week as a Go app, and despite it being invoked in a non-standard manner there is no documentation to explain this other than a couple of examples. Eventually I determined the platform is OpenWhisk and went to read their code.
Additionally, the web UI gives you only a single editor to edit a main file, and the moment you include an external dependency you have to switch to the CLI deployment method which is also poorly documented and vastly more hassle than the web UI.
A smoother experience would be most welcome.
H
Hannan Rhodes
I absolutely agree. I a am making a function using pip packages and the only speck of documentation is this sample repo https://github.com/digitalocean/sample-functions-python-jokes.
Does not go into any detail on how build scrips work and I constantly run into errors and un-documented details.
Please DO, get someone on this.
Matt Welke
Hannan Rhodes: We published an update to our docs last week, which includes some details on how to use PyPI packages with Python functions (https://docs.digitalocean.com/products/functions/reference/runtimes/python/#use-modules-and-dependencies). Be sure to let us know here if you have more feedback about the Functions docs. If you have questions about how to use Functions, you can ask questions in our Community Q&A or by creating a support ticket.
Nick Moore
+1 to this. At the moment the Functions documentation is very poor. Even something as simple as how to return a HTTP status code from the function is not mentioned in the docs.
Here are two examples I ran into where the answer to a basic question is not in the docs, so people are having to ask in the community forums: