Improve quickstart full-managed docs #227

New issue

Open

opened 2026-05-03 02:50:21 +00:00 by modalala · 2 comments

modalala commented

2026-05-03 02:50:21 +00:00

(Migrated from codeberg.org)

On https://docs.caution.co/quickstart/fully-managed/

Section https://docs.caution.co/quickstart/fully-managed/#what-you-need :

could contain more info about passkeys.
possibly, needed distro packages.
confirm conatinerd is all that is required (other docker stuff might be needed, for example BuildKit).

Section https://docs.caution.co/quickstart/fully-managed/#initialize-the-application :

consider documenting the creation of caution's remote in git. caution init adds the caution remote. It does this in stdout: Added git remote 'caution': ssh://git@dashboard.caution.co:2222/<ID>.git so perhaps this is enough.
consider editing "A Procfile defines how to run your application and which ports to expose." -> open ports is somewhat ambiguous because I am altering local state, but I believe this means what ports will be exposed on the deployed app.
Also mention the possibility the use can edit, then push Procfile, because caution init will create one, but it can be edited and re-pushed to try if the Procfile doesn't work immediately.

On https://docs.caution.co/quickstart/fully-managed/ Section https://docs.caution.co/quickstart/fully-managed/#what-you-need : - could contain more info about passkeys. - possibly, needed distro packages. - confirm `conatinerd` is all that is required (other docker stuff might be needed, for example `BuildKit`). Section https://docs.caution.co/quickstart/fully-managed/#initialize-the-application : - consider documenting the creation of caution's remote in `git`. `caution init` adds the caution remote. It does this in `stdout`: `Added git remote 'caution': ssh://git@dashboard.caution.co:2222/<ID>.git` so perhaps this is enough. - consider editing "A Procfile defines how to run your application and which ports to expose." -> open ports is somewhat ambiguous because I am altering local state, but I believe this means what ports will be exposed on the deployed app. - Also mention the possibility the use can edit, then push `Procfile`, because `caution init` will create one, but it can be edited and re-pushed to try if the `Procfile` doesn't work immediately.

anton commented

2026-05-03 19:16:09 +00:00

(Migrated from codeberg.org)

These all sound like reasonable docs improvements. This feels like an issue to open in docs, but it's fine to leave it here since you already opened it here and most of the action happens in this repo.

modalala commented

2026-05-10 22:49:11 +00:00

(Migrated from codeberg.org)

Under https://docs.caution.co/quickstart/fully-managed/#deploy-the-application

I made the mistake of naively using git push caution main, which assumes that the local branch is also main, in addition to the remote main branch of the caution repo. See also #238

IIUC this is the same as git push caution main:main.

Making a note here about the implicit repo setup might be a good idea for someone who is following docs without understanding this is an implicit git command. Or, alternately substitute the explicit command above.

Under https://docs.caution.co/quickstart/fully-managed/#deploy-the-application I made the mistake of naively using `git push caution main`, which assumes that the local branch is _also_ main, in addition to the remote `main` branch of the `caution` repo. See also #238 IIUC this is the same as `git push caution main:main`. Making a note here about the implicit repo setup might be a good idea for someone who is following docs without understanding this is an implicit `git` command. Or, alternately substitute the explicit command above.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

public/platform#227

No description provided.

Rows
Columns