Content for the smaller use cases

[Preeticp]

Question: Are we going to have the same content in it as the GS or would it cover other features of OSIO too?
Suggestions, open for discussion:

1. We can have a higher heading called GS and below it Creating an app and Importing an App could be the main subheadings. These probably should be our primary emphasis points.

• Question: Spring boot would be our main focus, do we also want to add a section on Vertx in addition here or park it somewhere else?
• I suggest we keep the Creating and Importing App flows purely focused on Creating app, reviewing on stage, pushing to run, editing your code base, and reviewing it. Planning seems to be forced into the workflow as of now, thoughts? Also currently it deals with optimizing resources which will not be part of this flow.
• We should change the titles to Creating an application/a codebase and Importing an existing application or codebase. OpenShift refers to 4/5 different projects which deal with the one application we create. This would avoid that confusion. Also, that way a development project could include planning, creating an app, analyzing, team/auth etc.

2. Other modules we need to cover, which may not be covered in detail currently are (could not check this due to the 404s):

• Planner: Currently only GS section is covered which does not cover details like templates, WITs available, list and board Views. Query builder is going to be the new emphasis point, we need to see where this fits and how. The list view revamp was hinted at. Having said this, the current UG section on this definitely needs to be pared down and organized better. Maybe use a getting started with Planner type perspective?
• Analytics: Not sure how much of it is covered in the use cases already. Few more details on the stack report than what's in the GS section currently would be useful.
• Pipeline details: There are sections both in UG and in the GS which are more relevant to this kind of a use case.
• Deployment of Application: The GS captures a bit of this but do we need more content on Scaling up and scaling down pods?
• When it comes in, the Authorizations and Permissions part might need to be covered too, more than what's currently in UG/GS, (not yet sure whether as a part of each use case it affects or separately).
• Glossary, this seems very useful as per feedback we received earlier, should this go in separately?

3. Some minor things: 'Debugging' section and 'comprehensive guides' have same heading level as 'Documentation for end users', numbering in debugging section.

Thoughts please.

[mishaone]

I like the idea of having the main use cases being creating or importing apps. Those are the primary things one would do anyway. Beyond that, we can have things like optimizing the app code, etc. which incorporate the relevant features and planning work separately as well perhaps? I admit I also find it shoehorned in a bit at the moment. I can't see any individual developer bothering with tracking the workflow unless they were working with others or in a team and need to track progress. Thoughts?

Also, if you have ideas, @Preeticp, please feel free to list the tentative use cases you would suggest in order, which makes it easier to see what you propose and comment on that specifically.

[Preeticp]

@mishaone the list above are my suggestions and this issue is primarily a discussion issue. (We may want to wait on the Planner a bit though).
Currently, I am unable to see the existing break up of content yet. I was waiting to see it to get a better idea about the existing plan.

[Preeticp]

This will affect #406 too as both of these issues are dependent on each other

[Preeticp]

#428 takes care of almost all of the above points except for:

• Pipeline details: Currently it did not make sense for me to keep this section apart from the Create and Import workflow, but I will have a go at it again when I deal with [after review+update] streamline GS workflow to be minimalistic #406
• Deployment of Application: Currently we do not have more info than already captured, maybe later if there are more things captured in the deploy part, then we can have a section on this.
• Authorizations and Permissions: Nothing end user facing I have seen so far. Planner had some plans on it, but not yet implemented.
• Slightly related, we can update the Area and Collaborators section to have a smaller user story on Team collaboration, this section could also house the planner section as lot of it is interrelated, Issue Update Collaborator and Area section in UG #434.
• Glossary, not sure if this is a good candidate for modular guides, seems more like a reference doc. OOH, probably a good idea to add the modules for troubleshooting and Glossary together in the Getting help and giving feedback on OpenShift.io user story.

Keeping this issue open for further discussion and follow up action.

[Preeticp]

A new User story for Auth/Area and Collaborator section has been added via #484 and #483 This takes care of the 3rd and 4th bullet points above.