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

Consolidate documentation #88

Open
3 tasks
afred opened this issue Dec 3, 2024 · 0 comments
Open
3 tasks

Consolidate documentation #88

afred opened this issue Dec 3, 2024 · 0 comments

Comments

@afred
Copy link
Collaborator

afred commented Dec 3, 2024

Because

We have deploy_instructions and README.md and the deploy script's USAGE that displays when you run it. Would be great if this was all just in the README.md, keeping the in-line docs in deploy.

Background

Using the Docker container (with the docker script) is very convenient and can be done without having to set up a local Ruby environment. However inside the Docker container is a Capistrano deployment, which should still be able to be used if you want to set up your local Ruby environment (e.g. with rvm), or if you are modifying the deployment code and/or the container and need to shell into it. Point being, the docs about running the cap commands are still relevant, so let's keep them.

Done when

  • README.md is reviewed
  • Deploy instructions are copied into README.md.
  • "Happy path" deployment is clear using code block for quick copy+paste
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant