Skip to content
This repository has been archived by the owner on Nov 2, 2023. It is now read-only.

Review docs #295

Closed
florianm opened this issue Mar 11, 2022 · 1 comment · Fixed by #305
Closed

Review docs #295

florianm opened this issue Mar 11, 2022 · 1 comment · Fixed by #305
Assignees
Milestone

Comments

@florianm
Copy link
Contributor

florianm commented Mar 11, 2022

Once the docker-compose deployment is in production for both build and build2xlsform, I'd love to review and update the docs in this repo.

If this were entirely up to me, I'd suggest:

  • Drop offline branch and replace with instructions to run docker-compose locally.
  • Drop ansible branch in favour of deployment through docker-compose.
  • Remove references to deprecated branches and deployments from docs and code.
  • Reduce overlap in docs:
    • architecture.md: Explanations of how Build works.
      • navigating code
      • dependencies
      • server side and database
      • deployment options (source, docker-compose)
    • contributing.md: Explanations of how to work on Build.
      • code of conduct, communication and collaboration with core team
      • development process (build and run code locally, common pitfalls)
      • local testing (build and run Docker images locally)
      • deployment process
      • migration pathway for production database (pg_dump into local folder, bind mount, pg_restore into docker service's db)
      • maintenance: how to run management commands against the running odkbuild container, e.g. update a user's password from the Ruby shell irb
    • README.md: shorten to refer to above docs.
  • Include a release issue template with a checklist for the release process
@florianm florianm added this to the 0.4.2 docker milestone Mar 11, 2022
@florianm florianm self-assigned this Mar 11, 2022
@florianm
Copy link
Contributor Author

Status quo:

Next steps:

  • Deploy build 0.4.2 with build2xlsform 1.9 to staging (source install)
  • Change staging to docker-compose and migrate db using transfer bind mount
  • Update docs with docker-compose as main deployment process

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant