Import alertmanager docs #1062

josedonizetti · 2017-10-31T01:11:46Z

This is part of the ongoing work to versioned prometheus documentation.
prometheus/docs#857

brian-brazil · 2017-10-31T08:48:26Z

docs/index.md

+- [Overview](overview.md)
+- [Introduction](introduction.md)
+- [Configuration](configuration.md)
+- [Clients](clients.md)


Clients should go last, that's a technical reference very very few people need.

brian-brazil · 2017-10-31T08:48:52Z

docs/index.md

+- [Introduction](introduction.md)
+- [Configuration](configuration.md)
+- [Clients](clients.md)
+- [Notifications](notifications.md)


The word Template should be in here

brian-brazil · 2017-10-31T08:49:29Z

docs/index.md

@@ -0,0 +1,16 @@
+---


Are the indexes not automatically generated?

@brian-brazil not sure about it. I didn't get the idea that the index.md on the promo repo was generated. Is there any reference about this?

If you look at them they're just the section title, with nothing else.

@grobie how did you generate the index.md on the prometheus doc?

I wrote the index.md by hand actually. My intent was to give users who read the docs locally a starting point. It was not meant to be just a list of the pages, but to include a small introduction as well. We can change that, but I guess a little explanation that the main documentation lives on a page online would be nice.

@brian-brazil @grobie should I add a brief content to it, or just remove it for now?

I'd keep it as starting point. But I'm fine with either.

grobie

Thanks a lot @josedonizetti! One last comment, then let's merge this!

grobie · 2017-11-08T10:48:07Z

docs/clients.md

+---
+title: Clients
+sort_rank: 6
+nav_icon: sliders


Remove all the nav_icon settings please.

josedonizetti · 2017-11-08T14:45:18Z

@grobie Done! Question, after this is merged how will be the process to update the documentation?
When a PR is merged to change the documentation here, will the docs project rebuild itself or something else is needed?

grobie · 2017-11-08T22:47:43Z

We use https://www.netlify.com/ now to build and host the docs. They provide webhooks and I configured prometheus/prometheus to use the trigger that on every push. I'll do the same for alertmanager.

I need to make some changes to the docs repo to support multiple versioned repo docs. Took some shortcuts on the way.

josedonizetti · 2017-11-09T15:23:54Z

@grobie

@stuartnelson3 is cutting a new release for alertmanger, and there are some important changes that must be updated in the documentation (pagerduty, and opsgenie were upgraded to a new version of their APIs) #1089

Do we change the existing docs so users have it properly there, and later update it here, or the change you will do on the docs repo to support alertmanager is coming soon and we wait to update it only here?

grobie · 2017-11-09T15:29:39Z

I'm almost done with the nanoc4 upgrade. I hope to have the changes ready tonight or latest Saturday night.

josedonizetti · 2017-11-30T15:39:29Z

@grobie Any updates on this? Anything I can help?

stuartnelson3 · 2017-12-14T11:13:22Z

@grobie ping

grobie · 2017-12-14T23:44:28Z

ack

…

On Thu, Dec 14, 2017 at 12:13 PM stuart nelson ***@***.***> wrote: @grobie <https://github.com/grobie> ping — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1062 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAANaPbWjweXmFzck00V77jmz1lXPjH5ks5tAQLUgaJpZM4QMEYn> .

josedonizetti · 2018-01-17T17:55:24Z

@grobie Is this doc migration for alertmanager still happening?

aioue · 2018-01-26T13:27:14Z

any way I can help progress this merge?

grobie · 2018-01-26T14:32:39Z

Sorry for the delays. I've been busy with other projects recently. The blocker is a upgrade and rewrite of the code in prometheus/docs. I'm 70% done with that, but haven't had a chance to look into that again. I'll try to reserve some time over the weekend and get that done, so that you can update the docs here.

…

On Fri, Jan 26, 2018 at 2:27 PM Tom Paine ***@***.***> wrote: any way I can help progress this merge? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1062 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAANaKi-I9oHJqZsFyUsaDbr583S347yks5tOdK1gaJpZM4QMEYn> .

stuartnelson3 · 2018-02-27T09:26:20Z

@grobie status on this?

juliusv · 2018-06-01T21:34:51Z

@grobie Ping. Status?

grobie · 2018-06-03T21:44:43Z

No progress. Depends on a change and rewrite of the docs infrastructure. I'll try to pick that up again during the next two weeks, but can't guarantee anything.

juliusv · 2018-06-05T11:33:38Z

@grobie Is this something that Luc (our new docs person) could help with, or are you too far into it?

roidelapluie · 2020-06-09T19:13:48Z

Superseeded by #2292 , and prometheus/docs#1657

josedonizetti · 2020-06-11T15:21:44Z

Considering @roidelapluie work, I’m closing this PR.

josedonizetti added 4 commits October 30, 2017 21:03

Import alertmanager docs

3827b42

Fix links

2657fc0

Rename alertmanager to introduction

5f429bc

Add basic index

8b7a5f7

brian-brazil reviewed Oct 31, 2017

View reviewed changes

josedonizetti added 2 commits October 31, 2017 08:57

Move client last

1ac012c

Rename template docs

1c42173

grobie reviewed Nov 8, 2017

View reviewed changes

docs/clients.md Outdated

---

title: Clients

sort_rank: 6

nav_icon: sliders

Copy link

Member

grobie Nov 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove all the nav_icon settings please.

Remove nav_icon from docs

13eb3c0

sbadia mentioned this pull request Feb 2, 2018

docs: Update rules from the 1.x to 2.x format prometheus/docs#961

Merged

juliusv mentioned this pull request Jun 5, 2018

Documentations for AlertManager should be versioned on web. prometheus/prometheus#4216

Closed

juliusv mentioned this pull request Jun 28, 2018

Create versioned Alertmanager documentation #1441

Closed

nikopen mentioned this pull request Nov 7, 2018

No documentation on how to setup a custom email template #1602

Open

stale bot added the stale label Feb 17, 2020

juliusv mentioned this pull request Jun 7, 2020

Version Alertmanager prometheus/docs#1657

Merged

stale bot removed the stale label Jun 9, 2020

roidelapluie mentioned this pull request Jun 9, 2020

Release 0.20 docs #2292

Merged

josedonizetti closed this Jun 11, 2020

josedonizetti deleted the docs branch June 11, 2020 15:21

Import alertmanager docs #1062

Import alertmanager docs #1062

Uh oh!

Conversation

josedonizetti commented Oct 31, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

grobie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josedonizetti commented Nov 8, 2017

Uh oh!

grobie commented Nov 8, 2017

Uh oh!

josedonizetti commented Nov 9, 2017

Uh oh!

grobie commented Nov 9, 2017

Uh oh!

josedonizetti commented Nov 30, 2017

Uh oh!

stuartnelson3 commented Dec 14, 2017

Uh oh!

grobie commented Dec 14, 2017 via email

Uh oh!

josedonizetti commented Jan 17, 2018

Uh oh!

aioue commented Jan 26, 2018

Uh oh!

grobie commented Jan 26, 2018 via email

Uh oh!

stuartnelson3 commented Feb 27, 2018

Uh oh!

juliusv commented Jun 1, 2018

Uh oh!

grobie commented Jun 3, 2018

Uh oh!

juliusv commented Jun 5, 2018

Uh oh!

roidelapluie commented Jun 9, 2020

Uh oh!

josedonizetti commented Jun 11, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants