Skip to content

Commit

Permalink
fix Python-Markdown issue & misc config (#380)
Browse files Browse the repository at this point in the history
  • Loading branch information
littlecxm authored Dec 13, 2023
1 parent f062e5c commit cc941f7
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 50 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[*.md]
tab_width = 2
indent_style = space
indent_style = space
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.idea
site/
venv/
.venv/
*.pdf
99 changes: 50 additions & 49 deletions docs/Community_IRC.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@
As announced in the [forums](https://forum.armbian.com/topic/12803-armbian-irc-channel/) everyone interested can communicate in realtime using the [internet relay chat (or *IRC*)](https://de.wikipedia.org/wiki/Internet_Relay_Chat).
Well known clients for CLI are [Weechat](https://weechat.org/) or [Irssi](https://irssi.org/) and for GUI [Hexchat](https://hexchat.github.io/).

Besides that communication is also possible via _Discord_.
Besides that communication is also possible via *Discord*.

## 🔌 Connect

### IRC

Libera:

+ Server: `irc.libera.chat`
+ Ports: `6697` / non-encrypted: `6667`
+ Channel: `#armbian`
- Server: `irc.libera.chat`
- Ports: `6697` / non-encrypted: `6667`
- Channel: `#armbian`

OFTC:

+ Server: `irc.oftc.net`
+ Ports: `6697` / non-encrypted: `6667`
+ Channel: `#armbian`
- Server: `irc.oftc.net`
- Ports: `6697` / non-encrypted: `6667`
- Channel: `#armbian`

In order to enter main `#armbian` channels registration with Nickserv is mandatory. Check [Libera Chat documentation](https://libera.chat/guides/registration) for further information.

Expand All @@ -31,24 +32,23 @@ Simply click here: [https://discord.com/invite/armbian](https://discord.com/invi
Channels starting with `#armbian-` are relayed between Discord and Libera IRC so it does not matter if you join IRC or Discord as both receive your messages. Check `#welcome-and-rules` for more information.
The main `#armbian` channel is relayed between Discord, Libera IRC and OFTC IRC.


## 🛑 Rules

Forums registration terms and rules apply for our chats: [https://forum.armbian.com/terms](https://forum.armbian.com/terms)

## 💬 Channels

+ **`#armbian`** is the project's main channel. Issue tracking, peer-to-peer user support or [upcoming release planning talks](https://docs.armbian.com/Process_Release-Model/#release-planning).
+ **`#armbian-devel`** : build engine development topics
+ **`#armbian-desktop`** : desktop environment development
+ **`#armbian-csc`** unsupported/deprecated board talk
+ **`#armbian-allwinner`** Allwinner SoC talk
+ **`#armbian-amlogic`** Amlogic SoC talk
+ **`#armbian-broadcom`** Broadcom SoC talk
+ **`#armbian-rockchip`** Rockchip SoC talk
+ **`#armbian-offtopic`** General chit chat
+ **`#armbian-commits`** is a moderated channel. Whenever a new interaction with a [repository on Github](https://github.com/armbian/) happens it will be announced. Also newly added issues on [Jira](https://armbian.atlassian.net/projects/AR/issues/?filter=allissues) will be pasted. User chat is not possible.
+ **`#armbian-rss`** is a live forum feed. Whenever a new post in the Armbian Forums is made it will be announced here. User chat is not possible.
- **`#armbian`** is the project's main channel. Issue tracking, peer-to-peer user support or [upcoming release planning talks](https://docs.armbian.com/Process_Release-Model/#release-planning).
- **`#armbian-devel`** : build engine development topics
- **`#armbian-desktop`** : desktop environment development
- **`#armbian-csc`** unsupported/deprecated board talk
- **`#armbian-allwinner`** Allwinner SoC talk
- **`#armbian-amlogic`** Amlogic SoC talk
- **`#armbian-broadcom`** Broadcom SoC talk
- **`#armbian-rockchip`** Rockchip SoC talk
- **`#armbian-offtopic`** General chit chat
- **`#armbian-commits`** is a moderated channel. Whenever a new interaction with a [repository on Github](https://github.com/armbian/) happens it will be announced. Also newly added issues on [Jira](https://armbian.atlassian.net/projects/AR/issues/?filter=allissues) will be pasted. User chat is not possible.
- **`#armbian-rss`** is a live forum feed. Whenever a new post in the Armbian Forums is made it will be announced here. User chat is not possible.
Of course, you can also enable desktop notification in your favorite browser for the forums.

Everybody is free to join any of these channels.
Expand All @@ -60,52 +60,53 @@ Besides the services offered by IRC (like Nickserv or Chanserv) Armbian has set

**`ArmbianGithub`**

+ Has the purpose to fill #armbian-commits and #armbian-rss like described above
- Has the purpose to fill #armbian-commits and #armbian-rss like described above

**`DC-IRC`**

+ Has the purpose to relay messages between IRC and Discord. Applies for all channels beginning with `#armbian-`.
- Has the purpose to relay messages between IRC and Discord. Applies for all channels beginning with `#armbian-`.

<!---**`ArmbianTwitter`**
+ Recurring searches on Twitter for new Tweets from [*@armbian*](https://twitter.com/armbian) and when people are actually mentioning *Armbian*-->
- Recurring searches on Twitter for new Tweets from [*@armbian*](https://twitter.com/armbian) and when people are actually mentioning *Armbian*-->

**`ArmbianHelper`**

+ Allows searching for Issues and Task on [Jira](https://armbian.atlassian.net/projects/AR/issues)
+ If you know the actual task id simply write it to the channel and the bot will look it up. Like `AR-123`
+ Search issue by keyword/s in the summary. Like `,searchissue Allwinner H6`
- Allows searching for Issues and Task on [Jira](https://armbian.atlassian.net/projects/AR/issues)
- If you know the actual task id simply write it to the channel and the bot will look it up. Like `AR-123`
- Search issue by keyword/s in the summary. Like `,searchissue Allwinner H6`
Take note of the `,`. Will output up to three results.
+ Allows searching forums via Google API (not very precise though)
+ Example: `,g Allwinner H6 panfrost`
+ A few more minor commands, mostly used by staff or do not need introduction
+ `.nonprofit`, `.sed`, `.contribute`, `.rtfm`, `.fortune`, `.sunxi`, `.meson`, `help`, `help irc`, `.tvboxes`
+ Translation for non-native English speakers
+ Simply start your sentence with `--` at the beginning and the bot will translate your message regardless of the source language into English.
- Allows searching forums via Google API (not very precise though)
- Example: `,g Allwinner H6 panfrost`
- A few more minor commands, mostly used by staff or do not need introduction
- `.nonprofit`, `.sed`, `.contribute`, `.rtfm`, `.fortune`, `.sunxi`, `.meson`, `help`, `help irc`, `.tvboxes`
- Translation for non-native English speakers
- Simply start your sentence with `--` at the beginning and the bot will translate your message regardless of the source language into English.
*Note*: This services will be activated manually on demand (like planned meetings for example) since its backend generates cost.

## ❔ FAQ

+ Why are there so many people in the channel and nobody is talking?
+ It is pretty common for community IRC channels for people to simply *idle* there. Many also using so called IRC bouncers <https://en.wikipedia.org/wiki/BNC_(software>) that keeps their connection to the channel alive.

+ I wrote 'Hi' but nobody answered. How do I get support there?
+ Probably there is nobody around at the time. Keep in mind that all users are spread around the globe and therefore living in many different time zones.
It is a common habit to simply state your question or issue and then wait patiently for an answer. Depending how complex this may take up to a few hours because most Armbian contributors have detailed knowledge in a specific board family only.
+ Is the chat history public as well?
+ Yes. All conversation is redundantly logged. These logs are open to the public. You can find them here: [http://irc.armbian.com](http://irc.armbian.com)
+ Why do some people have odd hostnames like `@armbian/staff/lanefu` or `@user/username`?
+ These *hostnames* are so called project affiliation cloaks. These are meant to show a users affiliation to a specific project and their role there.
+ Can I have that too?
+ Yes. An Armbian affiliation cloak can be requested from *Werner* either via [forums](https://forum.armbian.com/profile/9032-werner/) or IRC. They usually will be granted if you are a well known member in forums, a contributor via Github or donated to the project. Make sure you identified yourself to Nickserv beforehand.
- Why are there so many people in the channel and nobody is talking?
- It is pretty common for community IRC channels for people to simply *idle* there. Many also using so called IRC bouncers <https://en.wikipedia.org/wiki/BNC_(software>) that keeps their connection to the channel alive.

- I wrote 'Hi' but nobody answered. How do I get support there?
- Probably there is nobody around at the time. Keep in mind that all users are spread around the globe and therefore living in many different time zones.
It is a common habit to simply state your question or issue and then wait patiently for an answer. Depending how complex this may take up to a few hours because most Armbian contributors have detailed knowledge in a specific board family only.
- Is the chat history public as well?
- Yes. All conversation is redundantly logged. These logs are open to the public. You can find them here: [http://irc.armbian.com](http://irc.armbian.com)
- Why do some people have odd hostnames like `@armbian/staff/lanefu` or `@user/username`?
- These *hostnames* are so called project affiliation cloaks. These are meant to show a users affiliation to a specific project and their role there.
- Can I have that too?
- Yes. An Armbian affiliation cloak can be requested from *Werner* either via [forums](https://forum.armbian.com/profile/9032-werner/) or IRC. They usually will be granted if you are a well known member in forums, a contributor via Github or donated to the project. Make sure you identified yourself to Nickserv beforehand.
If you cannot find yourself in the list above you are free to request an unaffiliated cloak from Libera staff. Join #libera for that.
+ How can I protect my nickname so nobody can spoof me?
+ Register your nick with Libera's Nickserv service. Check [https://libera.chat/guides/registration](https://libera.chat/guides/registration)
- How can I protect my nickname so nobody can spoof me?
- Register your nick with Libera's Nickserv service. Check [https://libera.chat/guides/registration](https://libera.chat/guides/registration)
Even though it is not mandatory you should register and identify with the services as other channels for example may not allow unregistered users to chat or join at all as anti-spam measure.
+ Why do some users have voice (+v) in channel?
+ As mentioned in [forums](https://forum.armbian.com/topic/12803-armbian-irc-chat/?tab=comments#comment-96828) "all contributors to the project, regardless if forums staff, contributor on Github or well known and longtime active user" may get voice on request.
+ Should I add **away** to my nick if I am AFK? Like **Werner|away**
+ No. Please use the `/away [reason]` command as intended. For an explanation please have a look at the [ZNC Wiki](https://wiki.znc.in/Awaynick).
- Why do some users have voice (+v) in channel?
- As mentioned in [forums](https://forum.armbian.com/topic/12803-armbian-irc-chat/?tab=comments#comment-96828) "all contributors to the project, regardless if forums staff, contributor on Github or well known and longtime active user" may get voice on request.

- Should I add **away** to my nick if I am AFK? Like **Werner|away**
- No. Please use the `/away [reason]` command as intended. For an explanation please have a look at the [ZNC Wiki](https://wiki.znc.in/Awaynick).

## 👉 Bottom line

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ plugins:
markdown_extensions:
- smarty
- footnotes
- mdx_truly_sane_lists
- toc:
permalink: True
- pymdownx.highlight:
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ markdown>=3.2
mkdocs>=1.3.0
mkdocs-material>=8.0.0
mkdocs-with-pdf>=0.9.3
mdx_truly_sane_lists>=1.3.0

0 comments on commit cc941f7

Please sign in to comment.