Commit Graph

56 Commits

Author SHA1 Message Date
Jeremy Stanley 121cc0e452 Add description to IRC channel reg example
OFTC's chanserv requires a channel description be provided when
registering it. Update the example in our documentation to reflect
that.

Change-Id: Iee61b8176b2b801b4843530e7570bad5000fe76e
2022-06-16 14:54:32 +00:00
Jeremy Stanley d185aedd7d Decommission status.openstack.org and services
The status.openstack.org server is offline now that it no longer
hosts any working services. Remove all configuration for it in
preparation for retiring related Git repositories.

Also roll some related cleanup into this for the already retired
puppet-kibana module.

Change-Id: I3cfcc129983e3641dfbe55d5ecc208c554e97de4
2022-04-29 16:34:51 +00:00
Ghanshyam Mann 4f2bbe301c Fix command for setting the entry message for IRC channel
In OFTC, entery message is set via ``entrymsg`` command,
correcting it in doc.

<ChanServ> *** SET Help ***
..
URL: Set the channel's homepage.
EMAIL: Sets the channel's e-mail address.
ENTRYMSG: Sets the channel greeting.
..

Change-Id: I2e436015641ab78c5b509b4b4ca35e1088c3376f
2021-12-15 16:02:40 -06:00
Jeremy Stanley 7685bf0708 Update management documentation for ptgbot service
Since ptgbot has updated config management and deployment
orchestration now, update our operational docs to reflect that.

Change-Id: Iad4eb23616ac8ad44d8456268dca730a9754acce
2021-10-07 19:34:16 +00:00
Ian Wienand 8a1f6d9764 Cleanup eavesdrop puppet references
Cleanup documenation, puppet references and the eavesdrop_opendev
group.

Change-Id: I67096d8eced0be54db9b1ee277b24602d8c20f00
2021-06-10 09:02:23 +10:00
Zuul 6ad774ad60 Merge "Explain when to add admins and ops with accessbot" 2021-06-07 01:33:33 +00:00
Jeremy Stanley 05c9b06f24 Explain when to add admins and ops with accessbot
We're happy for teams to manage their individual IRC channel access
lists through our accessbot configuration if they want, so explain
the situations in which they might choose to add channel ops or
admins, and the differences between them.

Change-Id: I4ae4463fe5017176d2d93cbaac6820fe11350899
2021-06-03 19:18:26 +00:00
Jeremy Stanley f56b1f29a9 Update IRC bot nick registration process for OFTC
The IRC bot nick registration process had Freenode-specific examples
and references, so switch those to reflect we're now using OFTC.
Also the weechat command-line syntax was outdated and did not work
with newer versions of the client, so fix that.

Change-Id: I74b60e997b32cc51e8db6e5b7a76d6f281dfc211
2021-06-02 17:27:14 +00:00
Jeremy Stanley c6137dce82 Update IRC bot troubleshooting doc for OFTC
The troubleshooting section of our IRC doc had examples specific to
Freenode, update those. Further, drop the bit about /etc/hosts on
eavesdrop, since OFTC offers an IPv4-only round-robin name we can
use directly in our meetbot configuration to work around the
TwistedPython+SSL+IPv6 DNS resolution bug without resorting to
hard-coding addresses on the server.

Change-Id: I7ac1542dcd0a4f088b8c475756338851994f5433
2021-06-02 17:27:14 +00:00
Jeremy Stanley f10bf949dc Update doc on banning disruptive users for OFTC
OFTC doesn't have a server-side remove command (I can't find
evidence that it even works on Freenode though I only bothered to
test on OFTC to confirm). Update this section of our IRC document
accordingly.

Change-Id: I6b7838327f0d4ea3ea8c3697fc784657bb2a64ff
2021-06-02 17:27:14 +00:00
Jeremy Stanley 32ffe17471 Update basic IRC operator commands doc for OFTC
Some syntax and available commands on OFTC differ from Freenode,
adjust them were necessary. In particular, setting the channel topic
through ChanServ isn't quite the same any longer.

Change-Id: Id24afc16f7f46476ef761132c9c9a7b491eda47f
2021-06-02 17:26:47 +00:00
Jeremy Stanley ae68744f09 Update accessbot instructions for OFTC
In order to accommodate the different permissions model on OFTC,
some changes were made to accessbot and its data structures. Correct
our documentation to reflect that.

Change-Id: I7a2c4201507dff2640b1506b885126d458b063a4
2021-06-02 15:32:48 +00:00
Jeremy Stanley 93e6a7116a Update channel renaming instructions for OFTC
There is no join forwarding in OFTC's network, so instead let's just
update channel topics and possibly set entry messages to let people
know when a channel has moved. In order to be considerate of the
network operators, remember to drop the old unused channel
registrations after a while.

Change-Id: Icbcc9b780ae3a2d1c19d2591158a9d36d0407582
2021-06-02 15:32:33 +00:00
Jens Harbott 5edb7debd6 Update our documentation to reflect the move to OFTC
Change-Id: Ibc90d1b988d65fe370fd46c0e5f7b457cb84152c
2021-05-31 15:26:58 +02:00
Clark Boylan 0116b2d025 Assort IRC TODOs
We're moving to OFTC and this tries to capture the various types of
updates for bots and docs we'll need to do. I don't expect this to
be complete, but adds some good reminder for a few things we don't
want to miss.

Change-Id: I09f4c7aa1a2eb8cd167439d58ab4222f5e63a4b1
2021-05-29 17:18:55 +00:00
Monty Taylor 96364a11d9 Stop cloning a bunch of puppet modules we don't use
We've stopped using many of these, but we never got around to
removing them from lists.

Also, we should probably retire the repos.

Depends-On: https://review.opendev.org/717620
Depends-On: https://review.opendev.org/720527
Change-Id: I8e012c5bfa48d274dbd7f5484a9e75fee080cb5e
2020-06-05 08:42:47 -05:00
Dr. Jens Harbott c86525ccd3 Update references to IRC channels
With the move from OpenStack governance to our own OpenDev team, we
should also move to use the #opendev IRC channel in preference to
the #openstack-infra channel which will remain in use for OpenStack
specific discussions.

Update the references in our docs accordingly.

Change-Id: I448704f5d2664fd233a69a2ad12578ca24d9878a
2020-03-18 17:33:08 +01:00
Monty Taylor d500651367 Rename cgit_file to git_file
In sphinx, we have a :cgit_file: directive that makes links to files.
Thing is - we're not using cgit anymore. So just rename it to git_file.

Change-Id: I80aca5fb3cc84281e29843944fea33e6f4d9fe6f
2019-04-22 11:47:11 +00:00
Monty Taylor e01ed4f066 Update some docs for opendev
There's a lot of these, so doing them in chunks. This fixes
the custom roles.

Remove the git and jjb docs, since we don't use them anymore.

Change-Id: I0c5b74f7b73315dac93bce6be0d920cddb94fb58
2019-04-20 09:41:45 -07:00
Thierry Carrez 77b58a8f62 Update doc for ptgbot to match current behavior
PTGbot no longer updates an ethercalc document.

Change-Id: If29ca58a5dd3e4933a111fa143a376151335f32f
2018-12-21 11:38:49 +01:00
Monty Taylor 55ddc7bf88
Ectomy some Jenkins out of the docs
There are a bunch of places where the narrative text say things like
"jenkins runs jobs". This hasn't been true for a while and it's getting
less true.

Left third-party and running-your-own alone because those are
instructions for other people to do things - and we are not yet at the
point where we are suggesting anyone do their things like we do our
things.

The devstack-gate document describes an old deprecated system, but the
system is still in use (sadly) so it was mostly left intact. A warning
was added so that people would be clear that it was deprecated.

Also removed the logstash client config file. It's the only change in
here that actually affects running code and became unnecessary when it
was switched to geard with Ie3f814e6d3278d87f2a20a72e40b6b92217684fc

Change-Id: Iaf2128c3f953976180c71cb599fcbff7bc06c28a
2018-12-10 17:55:04 +00:00
Andreas Jaeger 1c6b4876eb Cleanup docs formatting
Fix indents of some pages, the wrong indent let to gray bars besides
them.

Also, fix a typo and add some markup.

Change-Id: I6e7126ef7b782b376efcc7c6d69c6de9a504ddb5
2018-08-24 22:13:37 +02:00
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00
Monty Taylor bf6c624dc0
Remove an extra # from irc renaming instructions
There is a double # in the example topic. It's a typo.

Change-Id: Iff844b7e7d0a78bf7752bf5f144f40c754d81415
2017-11-28 16:54:25 -06:00
Jenkins 08441d68c3 Merge "Instructions for registering up a new IRC bot nick" 2017-07-13 20:02:53 +00:00
Jeremy Stanley df7e8848d3 Instructions for registering up a new IRC bot nick
In order to demystify some of the initial setup around IRC nick
registration for new bots, start a new section in the IRC
documentation page for a recommended workflow and gotchas.

Change-Id: Ica9f24b725cc2d4425741b383f788a537992f80d
2017-07-10 22:56:21 +00:00
Jeremy Stanley 5baefe21af Install ptgbot on eavesdrop.o.o
This installs the ptgbot Puppet module so it will run from the
eavesdrop.openstack.org server and generate its Web content there.
Include some rudimentary operational documentation.

Change-Id: I92ddbbb683dede2c325f70267bd5e26884a35c01
Depends-On: Idb1fc5273b67ab88e1c78578275969b04c781c7a
2017-07-06 21:03:48 +00:00
Jeremy Stanley 31cacb0564 Refactor IRC user banning documentation
To make it easier to find in a pinch, the IRC channel banning
documentation is given its own subsection and rearranged to make the
fastest and easiest solution appear as the first documented example.

Change-Id: If4d00927c3ac55a74b6ed1059269dbe872f18079
2016-11-02 17:32:19 +00:00
Jeremy Stanley 9edcdc58ff Add documentation about Chanserv's auto-kick list
As a persistent means of kick-banning users from a channel, you can
have Chanserv do the dirty work for you making your own nick less of
a target for retaliation.

Change-Id: Ia8dcd17c53ea8235598712d1d6b177770d9bd029
2016-07-26 14:49:54 +00:00
Jeremy Stanley b2952ef0bc Document how to reset statusbot wiki password
Change-Id: Idc309222ed745b9ae1ee60960a2dca2197c13b6a
2016-07-19 00:48:55 +00:00
Jeremy Stanley c4cfe04eee Link to Freenode's channel registration FAQ
Freenode has a "blog" post of an FAQ about the channel registration
process, which may be more useful to newcomers than our abbreviated
recipe. Link it.

Change-Id: I8f67d1c6baac60f99740d11acae28b1557fb435c
2016-04-14 19:20:59 +00:00
Jeremy Stanley 6b50f515ff Correct link to Freenode channel guidelines
Freenode has recently shuffled around their online documentation
without maintaining redirects from the old URLs, so update the link
to their channel guidelines accordingly.

Change-Id: I9bf3e697f3397f4c0490ab8ad5a72ebb8a385c99
2016-04-14 19:20:00 +00:00
venkatamahesh fbafc20189 Fix spell typos
Change-Id: I70fa2cc7e2fd35895cd11db57fef00199680ce2b
2016-02-04 06:21:20 +05:30
Jenkins e777d234a7 Merge "Add instructions on how to troubleshoot bots" 2016-01-08 19:52:37 +00:00
Elizabeth K. Joseph 6de660692b Update docs for adding channels to meet/statusbots
We've moved the long list of channels for statusbot and meetbot (logging) into
the hiera/common.yaml file, updating the documentation accordingly.

Change-Id: I2337de6c82a24fabe0d428ba3a7f40c8d41a62c8
2015-12-30 14:44:25 -08:00
Yolanda Robla 890a56d1b9 Add instructions on how to troubleshoot bots
Change-Id: I18ed46a1f1a87d6545541502f499eeab5e80c692
2015-12-28 09:41:15 +01:00
Elizabeth K. Joseph 0fc8badd49 Add docs for renaming an IRC channel
Change-Id: I26dbddcd00aa38e18f4c7c3e1374aab745524d96
2015-12-14 10:32:56 -08:00
Jenkins 8389892a5f Merge "Docs: Adding accessbot info to the IRC services page" 2015-10-27 12:51:52 +00:00
Thierry Carrez fd200382b4 Enable the #success feature in statusbot
This adds the configuration bits to enable the #success command
in statusbot.

Depends-On: I66b577732d1fec271a42f9229a8b5af2e52a58f4
Change-Id: Id26fb1a9dc27874040d2f5dd05bf20140d07512b
2015-10-07 11:16:43 -07:00
Rafael Folco bc89587a1f Docs: Adding accessbot info to the IRC services page
Documentation points to gerribot but it does not mention about
accessbot while creating and setting IRC services for a given
project.

Change-Id: I974bff563e9142b050024023d8494da5826c3ef3
2015-09-23 16:53:48 -05:00
Elizabeth K. Joseph 8530499252 Add some basic IRC Op documentation
Change-Id: I3cb5869e5250d47788cd95190c7621cadd2ea4c6
2015-07-16 14:25:25 -07:00
James E. Blair aafabdcf67 Document startmeeting in our meetbot fork
Change-Id: I08b474a60c688ff61bb931f3170a8699ba165b4f
2015-06-23 10:53:07 -07:00
James E. Blair f7ff83dc38 Document IRC channel registration commands
Change-Id: I94a98f7979d5909fac8cf122f27d97e6f1b65d87
2015-05-07 08:42:23 -07:00
Jenkins 802334fdb5 Merge "Update documentation with new Puppet modules" 2015-01-29 17:06:12 +00:00
Elizabeth K. Joseph 11a9b7ccce Update documentation with new Puppet modules
Location of our Puppet modules has changed now that they are split
from system-config, update documentation accordingly.

Change-Id: I4d4adc5d41f50dd92fbd642ac30f95c327a416b2
2015-01-28 19:48:10 -08:00
Elizabeth K. Joseph 6d15acd0e8 Add +e mode to our documentation for IRC bots
Freenode has added a +e permission that we need added to the
openstackinfra account as well, document this.

Change-Id: I28bf99119a5d7a906b27d43104b0fcd7c7c0ed42
2015-01-16 09:27:22 -08:00
Michael Krotscheck bdd6abcac8 Switched documentation to point to storyboard.
We've migrated this project to storyboard, I'm updating the
documentation links.

Change-Id: Id92552b7be7cd43ca6a3ec91c2c4f330078490b6
2014-11-12 14:48:02 -08:00
James E. Blair f605d6e6ce Doc updates for project-config
Change-Id: Idffa13d5d1990f47e46fc5b711563949da78b6f8
2014-09-25 11:03:04 -07:00
Andreas Jaeger 1a3aa9a054 Fix doc8 issues
Remove extra whitespace.
Wrap overlong lines.
Remove extra ".." in one place

Change-Id: Ib7280a87ddb663a8ab27308ffd67d19f0b0f7b09
2014-09-04 17:47:35 +02:00
Elizabeth K. Joseph 7189391f89 Update IRC documentation to mention logging
Logging of meetings and channel is handled by the Supybot, update
documentation to explain both logging mechanisms and how to add
channel logging to the configuration.

Change-Id: I0e7f53f3699cc3352dbbe31379d4753d291a3c9d
2014-07-31 14:17:59 -07:00