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 usage documentation #62

Closed
Ellipse0934 opened this issue May 28, 2024 · 2 comments
Closed

Add usage documentation #62

Ellipse0934 opened this issue May 28, 2024 · 2 comments

Comments

@Ellipse0934
Copy link

Instead of linking to the blog post we should have basic usage instructions here itself. Because:

  1. There is a discrepancy in the docker image url. Post suggests freshtracks.io/avalanche meanwhile the README gives prometheuscommunity/avalanche. I assume we want to suggest the latter.
  2. The blogpost has images which cannot be copy pasted for convenience and must be manually written.
  3. Editorial control should be maintained in the repo .

I'm happy to make a PR on this. I think we should suggest a compose file:

version: "3.0"
services:
  prometheus:
    container_name: prometheus
    image: prom/prometheus
    ports:
      - "9090:9090"
    volumes:
      - ./config/Prometheus.yml:/etc/prometheus/prometheus.yml
    networks:
      - prom
  avalanche:
    container_name: avalanche
    image: quay.io/prometheuscommunity/avalanche:main
    ports:
      - "9001:9001"
    networks:
      prom:
        aliases:
          - avalanche
networks:
  prom:
    name: prom
@Ellipse0934
Copy link
Author

I have a tree with this work but I'm not happy with it. https://github.com/Ellipse0934/avalanche/tree/ap/readme

I think I'll wait until there are a few more features merged in and someone available to review.

@bwplotka
Copy link
Member

Where do we link blog post? Perhaps we fixed it already? I will assume it's done and close it, we can reopen later. (:

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

2 participants