Create list of tasks to document in Appsody docs

[helenmasters]

As part of the epic #257 we've had a first look at the existing menus on https://appsody.dev. One of the options under discussion for streamlining the documentation is to split it into Reference and Task based items.

It would be helpful to have a list of user tasks which the Appsody team feel need to be documented. Please can you add tasks to the list below, these can be rationalised later so more rather than less in the list is better at this stage (please DO include tasks we don't currently have docs for!):

• Installation
  • Upgrading
  • Uninstalling
• Initializing projects
• Creating a stack
• Upgrading a stack
• Editing a stack
• Building
• Deploying
• Managing Appsody apps

[kylegc]

I think the obvious one missing is running/debugging/testing an appsody app, i.e. the app developer using command appsody run (or debug or test). This is arguably the most important task appsody provides.

Here's a brain dump of other topics I can think of:

• Testing a stack
• How to choose a stack
• [future] Running appsody on kubernetes
• [future] Running/connecting to dependent services while developing appsody apps
• [future] Creating a private repository
• [future] Connecting to a private repository (security authentication)
• Setting up the appsody operator
• Deploying with knative vs operator
• Deploying with a tekton pipeline
• Version management (versioning stacks, dependencies, and the apps)
• Technical/architecture reference docs

[Kamran64]

A few ideas that probably can overlap with some of the tasks above:

• Components of a stack i.e. stack structure
• [future] Determining whether your stack is experimental, incubator or stable
• Maintaining a stack and appsody applications
• [future?] Validating a stack e.g. appsody stack lint, appsody stack validate etc.

[sympatheticmoose]

I think generally the correct topics are covered above - but i'm concerned by the wordings... so I just want to make sure we are treating this as the initial pass :)

We're talking 'tasks' - which to me should be in language which would make sense regardless of the users' familiarity with appsody (goal?). But a lot of whats listed above still assumes a lot of knowledge. If this is first pass/sub-topics - that should be ok... but I wanted to make sure in this effort we are focussing on workflows > tech used to implement.

For example - I would be looking for things like "developing an application" not "Initialising Projects". The latter would be a step instruction.

What does "managing appsody apps" mean? Stop/Start? Integration with something like urbancode?

Also the future on "running appsody on kubernetes" - I'm assuming this is based on running appsody itself on kubernetes which is part of our work with Eclipse Codewind. But could cause confusion compared with more common use - which would be appsody apps running on kubernetes.