docs: split building and deploying doc #563
Conversation
|
You'll need to add redirects, changes to the sidebar yaml and any direct website refs also need updating... |
|
|
||
| The Appsody CLI downloads and runs a *development* Docker image of the target runtime during local development. This image differs slightly from the image that is used at deployment time, because it configures tools that are useful only during the development phase. | ||
|
|
||
| The Appsody CLI provides the [`appsody build`](/docs/cli-commands/#appsody-build) command to generate a *deployment* Docker image on your local Docker registry. |
There was a problem hiding this comment.
It feels like this should be the first sentence and the sentence/paragraph above should be a note/comment underneath, as it seems strange to talk about development first on a page about build.
It also feels like it should say something like...
"The Appsody CLI provides the appsody build command to generate a deployment Docker image on your local Docker registry. You can then manually deploy that image to your runtime platform of choice.".
That is it should cover what is appsody build and why would you use it. Then we should note something about it it being included in appsody deploy as for some users they won't want to use build directly.
"If you want to build and deploy a Docker image directly to a locally installed Kubernetes cluster that you are using for testing or staging you might prefer to use appsody deploy (link to command) as it has the build command built into it." not the right wording probably but you know what I mean...
There was a problem hiding this comment.
I've tried to reword it taking this into account :)
|
I have added one redirect which is the main one. I think we can add redirects for anchor links that we are aware have been used externally. However, we will probably have to accept some breakages as we can't redirect every anchor header. I've also updated the sidebar yaml and any direct website link references |
|
Sandy, I dreamt about the docs last night (sad I know!). Is there a link from the deploying doc to the operator docs as I didn't notice one yesterday? There should be something to show users that there is more information in Reference otherwise we can't expect users to find it. |
|
@helenmasters haha sorry to hear about that. There is a link to the operator doc at the end of the |
skoh7645
dismissed
helenmasters’s stale review
requested changes have been addressed
Checklist
Description
Split up the "building and deploying" doc into " building", "deploying" and "appsody operator" docs. I tried to keep the content largely the same in this PR. Future PRs will be made to improve the actual content.
For easier reviewing:
# Getting ready to deploy your Appsody projectsection, and the last sentence in the### Deployment via the Appsody OperatorsectionRelated Issues
Related to #359