Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of each environment #77

Open
erwinvaneyk opened this issue Sep 14, 2018 · 0 comments
Open

Improve documentation of each environment #77

erwinvaneyk opened this issue Sep 14, 2018 · 0 comments

Comments

@erwinvaneyk
Copy link
Member

Currently the documentation for environments varies from environment to environment. Most of the environments lack info on common questions users have: How do I setup this environment? Which version should I use? What is the latest version of environment? Does it have a builder? Does it support functionality X?

We should ensure that the documentation is sufficient enough to help the user with these questions, which otherwise confuse the user at runtime and lead to pressure on the support.

I think it would help if we have some sort of a template or checklist what should be in the environment documentation. From the top of my head we should consider it to constitute of the following should be in there:

  • Cut-and-paste examples of most recent version
  • A table indicating what functionality is supported (builder, V2, V3, etc)
  • Links to examples
  • Build instructions
  • Some text on the functions./usage: how to set response code, how to get headers, body, and query params. What happens on exceptions?
  • Known issues/FAQ
  • Changelog on changes made to the environment
@gauravgahlot gauravgahlot transferred this issue from fission/fission May 20, 2021
@sanketsudake sanketsudake transferred this issue from fission/docs.fission.io Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant