augur icon indicating copy to clipboard operation
augur copied to clipboard

Update docker documentation

Open cdolfi opened this issue 8 months ago • 3 comments

Now that the docker build has been crystalized a bit the documentation needs to be updated. I am happy to take on this issue if someone points me on where I go to update https://oss-augur.readthedocs.io/en/main/docker/quick-start.html

cdolfi avatar Mar 31 '25 21:03 cdolfi

Hey @cdolfi, Just wanted to mention that I ran into some issues recently while setting up Augur with Docker, particularly around install-golang-deps.sh not being found during the build even though it exists in the repo.

I had to manually run a few pip installs and deal with Alembic/db config errors too. If you're updating the Docker Quick Start docs, happy to share details or collaborate on what might help new contributors avoid these roadblocks.

Also, thanks for taking on this, much appreciated!!

KhanRayyan3622 avatar Apr 02 '25 04:04 KhanRayyan3622

@KhanRayyan3622 Yes it would be great to hear more about your specific experience. Ill be working on this next week, happy to either tag you in my PR and we can talk about an additional section there or talk about it in this issue. Once errors were fixed my process was very simple and I have a feeling there is a few paths to success with this

cdolfi avatar Apr 06 '25 15:04 cdolfi

@cdolfi

Thanks for working on the Docker docs update! I ran into a couple of issues while setting up Augur with Docker;

  • install-golang-deps.sh wasn’t found during the build, but I fixed it by confirming the script’s file path and making sure it was executable.
  • Also had to manually run some pip installs and resolve some Alembic/db configuration errors.

I’ve documented the details in Issue #3101, which might be helpful for new contributors.

Feel free to tag me in your PR if you need help adding this info to the docs.

KhanRayyan3622 avatar Apr 06 '25 23:04 KhanRayyan3622

I am happy to take on this issue if someone points me on where I go to update https://oss-augur.readthedocs.io/en/main/docker/quick-start.html

https://github.com/chaoss/augur/blob/main/docs/source/docker/quick-start.rst is the file you want

MoralCode avatar Jul 02 '25 14:07 MoralCode

We tackled this a bit with #3159 and #3197 . I kept it open after my first PR bc I knew it was a step in the right direction, but unsure if it fully covered it. Would be great if you could follow the docs as you get augur set up locally and see if there is anything missing or additional context you feel would be helpful

cdolfi avatar Jul 02 '25 16:07 cdolfi