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

Add Docker image usage documentation #35

Closed
5 of 8 tasks
jerluc opened this issue Nov 4, 2020 · 1 comment
Closed
5 of 8 tasks

Add Docker image usage documentation #35

jerluc opened this issue Nov 4, 2020 · 1 comment
Labels
documentation Improvements to code or project documentation good first issue Good for newcomers
Milestone

Comments

@jerluc
Copy link
Member

jerluc commented Nov 4, 2020

Currently, the README only spells out how to install/use tilenol from source, but ideally most users would only be using tagged binaries. IMO we should update our README to:

  • Add a new "Docker" section to "Usage"
  • Add descriptions of Docker image tag conventions (e.g. devel vs. latest)
  • Add actual usage examples for the Docker image
  • Add Docker Hub link(s): https://hub.docker.com/repository/docker/stationa/tilenol
    • Update Docker Hub's "Readme" section with image usage

Moved the below to #32:

Optionally, we could also go a bit further by:

  • Connecting Docker Hub and Github to sync Docker Hub's "Readme" section
  • Use Github's new "package" feature to publish Docker images
  • Implement Auto-publish new build artifacts #32 to auto-publish new images and sync to our repo somehow
@jerluc jerluc added good first issue Good for newcomers documentation Improvements to code or project documentation labels Nov 4, 2020
@jerluc jerluc added this to the v1.1.0 milestone Nov 4, 2020
@jerluc
Copy link
Member Author

jerluc commented Nov 29, 2022

Closed in 1c09fc5

@jerluc jerluc closed this as completed Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to code or project documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant