Docs: Revise readme #1489
Docs: Revise readme #1489
Conversation
README.md
Outdated
|
|
||
| ## Contributing | ||
|
|
||
| To contribute to Grafana Mimir, see [Contributing to Grafana Mimir](./CONTRIBUTING.md). | ||
| To contribute to Grafana Mimir, refer to [Contributing to Grafana Mimir](./CONTRIBUTING.md). | ||
|
|
||
| ## Hosted Grafana Mimir (Prometheus as a service) |
There was a problem hiding this comment.
@jdbaldry , @KMiller-Grafana , @pracucci , this content is from the original readme, so I left it. Not sure if we should remove it.
README.md
Outdated
|
|
||
| Your feedback is always welcome. | ||
|
|
||
| ## Further Reading |
There was a problem hiding this comment.
@jdbaldry , @KMiller-Grafana , @pracucci , same here, lifted this from the Loki docs in case we have links to additional content. I suppose that we probably don't at this point, so I'm fine with removing it. Just wanted to check.
There was a problem hiding this comment.
We should link the videos and blog posts we prepared for the Mimir launch. I think the URLS won't be available until last minute, so I would remove this section so we can get this PR merged sooner and then open a PR at launch to add it with the right links.
There was a problem hiding this comment.
I'd vote for that too. Do we have a place for just-before/just-after launch tasks?
There was a problem hiding this comment.
Do we have a place for just-before/just-after launch tasks?
Richi's launch tracker.
There was a problem hiding this comment.
I also added a post-launch column to https://github.com/orgs/grafana/projects/120/views/1 where I'm tracking fast-follow work. I'll add a card there about enhancing the readme with links to blogs and videos.
README.md
Outdated
| [kccna18-slides]: https://speakerdeck.com/davkal/on-the-path-to-full-observability-with-oss-and-launch-of-loki | ||
| [kccna18-video]: https://www.youtube.com/watch?v=U7C5SpRtK74&list=PLj6h78yzYM2PZf9eA7bhWnIh_mK1vyOfU&index=346 | ||
|
|
||
| ## Building from source |
There was a problem hiding this comment.
@jdbaldry , @KMiller-Grafana , @pracucci , again, taken from Loki. I'm not sure what we'd put in here that isn't already covered in the deployment docs (which Jen is working on as I write...).
There was a problem hiding this comment.
I think this section shouldn't be part of the README. I would remove it from here.
README.md
Outdated
|
|
||
| Your feedback is always welcome. | ||
|
|
||
| ## Further Reading |
There was a problem hiding this comment.
We should link the videos and blog posts we prepared for the Mimir launch. I think the URLS won't be available until last minute, so I would remove this section so we can get this PR merged sooner and then open a PR at launch to add it with the right links.
README.md
Outdated
| [kccna18-slides]: https://speakerdeck.com/davkal/on-the-path-to-full-observability-with-oss-and-launch-of-loki | ||
| [kccna18-video]: https://www.youtube.com/watch?v=U7C5SpRtK74&list=PLj6h78yzYM2PZf9eA7bhWnIh_mK1vyOfU&index=346 | ||
|
|
||
| ## Building from source |
There was a problem hiding this comment.
I think this section shouldn't be part of the README. I would remove it from here.
Co-authored-by: Marco Pracucci <marco@pracucci.com>
Co-authored-by: Marco Pracucci <marco@pracucci.com>
* in-process copy edit * copy edit continues * in-process draft * Update README.md Co-authored-by: Marco Pracucci <marco@pracucci.com> * Update README.md Co-authored-by: Marco Pracucci <marco@pracucci.com> * incorporated first batch of feedback * addressed final feedback * adjusted doc URLs to latest * removed reference to apache exceptions * Fix typo Co-authored-by: Marco Pracucci <marco@pracucci.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Relates to #1486