platformsh-docs
platformsh-docs copied to clipboard
Add a step-by-step intro to Platform.sh
Besides the walkthrough in the console, we don’t really give a step-by-step guide.
Maybe something worth looking into for less technical people or potential customers that would like to understand how platform.sh works and how easy it is to get started? Or help understand where each piece falls in and link to the relevant sub-pages?
The current steps we do give in the walkthrough:
- Download the CLI (Opt)
- Add your SSH key
- Set Platform.sh remote
- Configure your project
- Configure services (Opt)
- Configure applications
- Configure routes
- Commit & push
- Import existing database (Opt)
- Import additional file
This guide could do the following:
- Explain the gitops philosophy, and the three main files (very briefly) - As excerpts from introduction and structure
- Link to git and ssh and the cli and explain why they are required.
- Point to the external source codes repositories (github, gitlab, ...) explain to the customer that they can either re-use their existing codebase (add remote) or start from scratch (lando + different templates) and basically take steps 1-3 (from the walkthrough).
- explain that the three "special" files are required to be able to deploy - step 4.
- Steps 5-10
- Explain/link to the go live page to explain domain setup
- Give additional information on how to fine-tune performance, add cache, ..., get metrics and troubleshoot the environments
Oh and also it should probably cover things like:
in the following workflow with 2 developers working on the same branch:
dev_1> platform get <project> -e <branch>
dev_2> platform get <project> -e <branch>
dev_1> hack, hack, hack
dev_1> commit and git push -u platform <branch>
dev_2> ????
What should developer 2 do? platform get or git pull ?
(git pull is the correct answer)