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

Docs: split building and deploying page into multiple menu items #359

Open
helenmasters opened this issue Nov 11, 2019 · 2 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@helenmasters
Copy link
Contributor

The current building and deploying page on the appsody.dev site needs to be broken up as it's becoming far too large to maintain or find things in. Adding #354 would just make matters worse.

Michele, this your area of expertise, please can you help by defining the most important items or flows that you believe we need to document for users, my naive attempt is as follows but this might not make the most sense so feel free to ignore it:

  • Building an app
  • Deploying
    • Appsody operator? (we need an overview somewhere)
    • Deploying to Kubernetes
    • Deploying to Knative service (needs to include when and why you would choose to do this)
    • Security Considerations (RBAC etc.)

How and where do Installing OpenShift RedHat CodeReady Containers and Installing Kubernetes locally fit into the picture? And when would I choose to do which?

@helenmasters helenmasters added the documentation Improvements or additions to documentation label Nov 11, 2019
@chilanti
Copy link
Contributor

@helenmasters - I would suggest the following:

  • Have an intro do deployment options
    • Explain that there are two fundamental paths:
    1. Push/PR your code to an SCM system (like Github) and have a pipeline do the build/deploy for you
    2. Use appsody to deploy directly to Kube.
  • Building an app with appsody build
  • Deploy an app directly to Kube
    • Introduce the Appsody operator
    • Cover appsody deploy - let's avoid covering the old Knative path, as it's going away. In other words, only focus on the operator path, which has an option to deploy as Knative.
    • Discuss local vs. remote deployment (i.e. deploying to a local cluster vs deploying to a shared cluster)
    • Security considerations
  • Appendix on setting up a local deployment environment
    • Docker for Desktop vs Minikube vs Openshift CodeReady Containers

@skoh7645
Copy link
Collaborator

skoh7645 commented Apr 7, 2020

We have decided to accomplish this by splitting the "building and deploying" doc in to separate "building", "deploying" and "appsody operator" docs. We will then improve each doc in separate PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants