From 16f886f781af187be138691ad0ada09a3237b936 Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Apr 21 2019 14:36:03 +0000 Subject: branding: Rewrite project name as TeleIRC to match upstream --- diff --git a/.pagure/CONTRIBUTING.md b/.pagure/CONTRIBUTING.md index 86b6a28..22ba81f 100644 --- a/.pagure/CONTRIBUTING.md +++ b/.pagure/CONTRIBUTING.md @@ -1,4 +1,4 @@ -How to contribute to Teleirc SIG documentation +How to contribute to TeleIRC SIG documentation ============================================== -Report issues and submit pull requests for **Content Fixes** to [Teleirc SIG documentation](https://docs.fedoraproject.org/en-US/???/) here. +Report issues and submit pull requests for **Content Fixes** to [TeleIRC SIG documentation](https://docs.fedoraproject.org/en-US/???/) here. General appearance issues and publishing issues should be reported against the [publishing software](https://pagure.io/fedora-docs/docs-fp-o). Never done a pull request (or "PR")? diff --git a/README.md b/README.md index d11a504..f2388af 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -Teleirc SIG +TeleIRC SIG =========== -The Teleirc SIG is a volunteer-driven group to manage [Teleirc](https://github.com/RITlug/teleirc) bridge bots. +The TeleIRC SIG is a volunteer-driven group to manage [TeleIRC](https://github.com/RITlug/teleirc) bridge bots. They connect Fedora IRC channels to [Telegram](https://telegram.org/) groups. The bridges make project discussion more accessible to others, if IRC is not a convenient option for them. diff --git a/docs/antora.yml b/docs/antora.yml index 65d8561..d0cbae3 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -2,13 +2,13 @@ # Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page) name: teleirc-sig -# Title will be visible on the page. -title: Fedora Teleirc SIG +# Title will be visible on the page. +title: Fedora TeleIRC SIG # If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version. version: master -# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise. +# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise. start_page: ROOT:index # This lists all the menu definitions of your component. diff --git a/docs/modules/ROOT/pages/_partials/attributes.adoc b/docs/modules/ROOT/pages/_partials/attributes.adoc index 7d8d845..ae23245 100644 --- a/docs/modules/ROOT/pages/_partials/attributes.adoc +++ b/docs/modules/ROOT/pages/_partials/attributes.adoc @@ -1,3 +1,3 @@ :FWIKI: https://fedoraproject.org/wiki -:TELEIRC: https://github.com/RITlug/teleirc[Teleirc] +:TELEIRC: https://github.com/RITlug/teleirc[TeleIRC] :YEAR: 2019 diff --git a/docs/modules/ROOT/pages/create-new-bot.adoc b/docs/modules/ROOT/pages/create-new-bot.adoc index a51f996..0cecc3c 100644 --- a/docs/modules/ROOT/pages/create-new-bot.adoc +++ b/docs/modules/ROOT/pages/create-new-bot.adoc @@ -1,8 +1,8 @@ include::{partialsdir}/attributes.adoc[] -= Create a new Teleirc bridge += Create a new TeleIRC bridge -This guide explains how to create a new Teleirc bridge. +This guide explains how to create a new TeleIRC bridge. It explains updating the Ansible project, opening a pull request, and pushing changes to production. @@ -26,7 +26,7 @@ Set up Ansible Vault on your workstation with these steps: _For SIG members only._ -Add your system user on the Teleirc host machine to the Teleirc admin group. +Add your system user on the TeleIRC host machine to the TeleIRC admin group. Authorized users are listed at `roles/teleirc/vars/main.yml`. Add a new line to the list with your FAS username to grant access. @@ -78,7 +78,7 @@ Add provided Telegram secrets in the following format. Note this list is also sorted alphabetically: ---- -vault_bots: +vault_bots: fedora_TEAMNAME: vault_irc_nickserv_password: "" // <1> vault_teleirc_token: "00000:0000000000" // <2> diff --git a/docs/modules/ROOT/pages/for-against-teleirc.adoc b/docs/modules/ROOT/pages/for-against-teleirc.adoc index c092910..c27146e 100644 --- a/docs/modules/ROOT/pages/for-against-teleirc.adoc +++ b/docs/modules/ROOT/pages/for-against-teleirc.adoc @@ -1,9 +1,9 @@ include::{partialsdir}/attributes.adoc[] -= Advantages and disadvantages to Teleirc bridges += Advantages and disadvantages to TeleIRC bridges Are you considering a {TELEIRC} bridge? -This page attempts a neutral view on pros/cons to using a Teleirc bridge for your sub-project, team, or SIG. +This page attempts a neutral view on pros/cons to using a TeleIRC bridge for your sub-project, team, or SIG. == Advantages diff --git a/docs/modules/ROOT/pages/get-involved.adoc b/docs/modules/ROOT/pages/get-involved.adoc index 16f816f..b5b8c1a 100644 --- a/docs/modules/ROOT/pages/get-involved.adoc +++ b/docs/modules/ROOT/pages/get-involved.adoc @@ -1,8 +1,8 @@ include::{partialsdir}/attributes.adoc[] -= Get involved with Teleirc SIG += Get involved with TeleIRC SIG -Want to help as a volunteer sysadmin for the Teleirc SIG? +Want to help as a volunteer sysadmin for the TeleIRC SIG? This page explains how to contribute and how to get involved. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 21a076a..92bcd6b 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,8 +1,8 @@ include::{partialsdir}/attributes.adoc[] -= Teleirc SIG += TeleIRC SIG -The Teleirc SIG is a volunteer-driven group to manage {TELEIRC} bridge bots. +The TeleIRC SIG is a volunteer-driven group to manage {TELEIRC} bridge bots. They connect Fedora IRC channels to https://telegram.org/[Telegram] groups. The bridges make project discussion more accessible to others, if IRC is not a convenient option for them. diff --git a/docs/modules/ROOT/pages/request-new-bot.adoc b/docs/modules/ROOT/pages/request-new-bot.adoc index 014a556..4b0c2b4 100644 --- a/docs/modules/ROOT/pages/request-new-bot.adoc +++ b/docs/modules/ROOT/pages/request-new-bot.adoc @@ -1,8 +1,8 @@ include::{partialsdir}/attributes.adoc[] -= Request a new Teleirc bridge bot += Request a new TeleIRC bridge bot -The Teleirc SIG is responsible for "bridges" between IRC channels and Telegram groups. +The TeleIRC SIG is responsible for "bridges" between IRC channels and Telegram groups. Fedora community members may request new bridges to connect an IRC channel to a Telegram group. If you are part of a larger sub-community, discuss bridging with your team _before_ making a request. @@ -13,7 +13,7 @@ First, create a Telegram bot via the Telegram API account (BotFather). The upstream project https://teleirc.readthedocs.io/en/latest/installation/#create-a-telegram-bot[provides documentation] on how to do this. Follow all instructions for the bot to work as expected (note the bot privacy setting). The BotFather gives you a Telegram API token after creating the bot. -Later, you will provide this token to the Teleirc SIG. +Later, you will provide this token to the TeleIRC SIG. _Note_: Whoever creates the Telegram bot is the only person able to make configuration changes to the bot. It is not yet possible to "share" Telegram bots with other users. @@ -30,7 +30,7 @@ Instructions on how to retrieve a Telegram chat ID are found on https://stackove == Open public ticket with request -Next, open a https://pagure.io/sig-teleirc/infrastructure/new_issue[new issue] on the Teleirc SIG _infrastructure_ repository. +Next, open a https://pagure.io/sig-teleirc/infrastructure/new_issue[new issue] on the TeleIRC SIG _infrastructure_ repository. In your ticket, include the following information: * Team / sub-project name @@ -40,7 +40,7 @@ In your ticket, include the following information: == Send Telegram secrets via email -Finally, send the Telegram secrets in an email to the Teleirc SIG. +Finally, send the Telegram secrets in an email to the TeleIRC SIG. Include the following in your email: * Telegram API token diff --git a/playbooks/telegram-irc.yml b/playbooks/telegram-irc.yml index 32d8466..9ce26b9 100644 --- a/playbooks/telegram-irc.yml +++ b/playbooks/telegram-irc.yml @@ -1,5 +1,5 @@ --- -- name: provision Fedora Teleirc bridge bots +- name: provision Fedora TeleIRC bridge bots hosts: telegram-irc.fedorainfracloud.org become: yes diff --git a/playbooks/vagrant-test.yml b/playbooks/vagrant-test.yml index 9efa9a1..943e105 100644 --- a/playbooks/vagrant-test.yml +++ b/playbooks/vagrant-test.yml @@ -1,5 +1,5 @@ --- -- name: test Teleirc changes locally with a Vagrant virtual machine +- name: test TeleIRC changes locally with a Vagrant virtual machine hosts: all become: yes diff --git a/roles/teleirc/tasks/main.yml b/roles/teleirc/tasks/main.yml index 05eee14..14ca0ae 100644 --- a/roles/teleirc/tasks/main.yml +++ b/roles/teleirc/tasks/main.yml @@ -16,7 +16,7 @@ - nodejs - yarn -- name: create system user for Teleirc bots +- name: create system user for TeleIRC bots user: name: teleirc comment: "system user to run RITlug/teleirc bots - do not use" @@ -24,14 +24,14 @@ home: "/usr/lib64/teleirc" create_home: no -- name: add authorized users to Teleirc admin group +- name: add authorized users to TeleIRC admin group user: name: "{{ item }}" groups: teleirc append: yes loop: "{{ authorized_users }}" -- name: create root directory for Teleirc bots +- name: create root directory for TeleIRC bots file: state: directory path: "/usr/lib64/teleirc" @@ -82,7 +82,7 @@ setype: systemd_unit_file_t loop: "{{ bots|dict2items }}" -- name: start/enable each Teleirc systemd unit file +- name: start/enable each TeleIRC systemd unit file service: name: "teleirc-{{ item.value.cn }}" state: started diff --git a/roles/teleirc/templates/teleirc.service b/roles/teleirc/templates/teleirc.service index c27152b..fa8bf12 100644 --- a/roles/teleirc/templates/teleirc.service +++ b/roles/teleirc/templates/teleirc.service @@ -1,5 +1,5 @@ [Unit] -Description=Teleirc: Telegram + IRC bridge bot (for: {{ item.value.cn }}) +Description=TeleIRC: Telegram + IRC bridge bot (for: {{ item.value.cn }}) Requires=network.target After=multi-user.target