https://github.com/hayat01sh1da/github-wiki-organisers
This repository contains Ruby and Python scripts which categorise Wikis to namespace by the ownership unit on Home and Sidebar.
https://github.com/hayat01sh1da/github-wiki-organisers
automation minitest python ruby unittest work-efficiency
Last synced: 3 months ago
JSON representation
This repository contains Ruby and Python scripts which categorise Wikis to namespace by the ownership unit on Home and Sidebar.
- Host: GitHub
- URL: https://github.com/hayat01sh1da/github-wiki-organisers
- Owner: hayat01sh1da
- License: mit
- Created: 2024-10-15T13:04:55.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-08T14:01:56.000Z (over 1 year ago)
- Last Synced: 2025-02-08T15:19:36.720Z (over 1 year ago)
- Topics: automation, minitest, python, ruby, unittest, work-efficiency
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Python%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Ruby%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Export%20Unknown%20Wiki%20List%20for%20LLM%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Notify%20Uncategorised%20Wiki%20Count%20by%20Namespace%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Notify%20Unknown%20Wiki%20Count%20by%20Namespace%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22Update%20Wiki%20List%20on%20Home%20and%20Sidebar%22)
[](https://github.com/hayat01sh1da/github-wiki-organisers/actions?query=workflow%3A%22CodeQL%22)
## 1. Common Environment
- WSL (Ubuntu 25.10)
## 2. READMEs
- [Ruby](./ruby/README.md)
- [Python](./python/README.md)
## 3. Source Codes
- [Ruby](./ruby/)
- [Python](./python/)
## 4. How to Use
In any case, make sure that you declare the owner or the category of the Wiki on the top of the document as follows.
```markdown
Owner: @sample-owner
---
This is a sample Wiki.
```
```markdown
Category: sample-category
---
This is a sample Wiki.
```
### 4-1. Edit Wiki
#### 4-1-1. GUI
You can directly create, update and delete wiki pages on [github-wiki-organisers Wiki](https://github.com/hayat01sh1da/github-wiki-organisers/wiki).
These actions are managed as git commits.
#### 4-1-2. On Your Machine
GitHub Wiki is also managed as git repository, which allows you to use git commands, needless to say.
Follow the instructions below to edit wiki pages.
1. Run `git clone git@github.com:quipper/aya-issues.git` to clone Wiki.
2. Create, update or delete a wiki and make some differences.
3. Run `git add #{FILENAME}`, `git commit -m #{COMMIT_MESSAGE}` and `git push origin master` in order to push commit(s) to the remote repository.
- \* The branch you can see on GUI is `master`
⚠️ Make sure that you must not rename and move markdown file on CLI or change the title on GUI in case you lost the revisions.
You can also freely configure Home header passage.
Edit it on [./home_template/](https://github.com/hayat01sh1da/github-wiki-organisers/blob/master/home_template) based on the mode you are in.
### 4-2. Cron Jobs
#### 4-2-1. Update Wiki List on Home and Sidebar
[Update Wiki List on Home and Sidebar](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/update-wiki-list-on-home-and-sidebar.yml) runs to update wiki list on Home and Sidebar at 12:00 and 22:00 every weekday.
If there is any difference, it pushes a commit to the remote repository and send a notification to a Slack channel you would like to get information on.
As a sample, [#github-actions-notifications - hayat01sh1da](https://hayat01sh1da.slack.com/archives/C09BBHZPD5E) is set as the target channel.
> 【github-wiki-organisers Daily Wiki List on Home and Sidebar Update Report】
> Workflows: [Update Wiki List on Home and Sidebar](https://github.com/hayat01sh1da/github-wiki-organisers/blob/master/.github/workflows/update-wiki-list-on-home-and-sidebar.yml)
> Commit: 04debbe Update Wiki list on Home and Sidebar by GitHub Actions[bot] at 2025-08-16 15:02:27
> Source: [github-wiki-organisers Wiki](https://github.com/hayat01sh1da/github-wiki-organisers/wiki)
#### 4-2-2. Notify Unknown Wiki Count by Namespace
[Notify Unknown Wiki Count by Namespace](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/notify-uncategorised-wiki-count-by-namespace.yml) runs to notify unknown wikis in terms of ownership at 09:00 every Monday.
If there is any difference, it pushes a commit to the remote repository and send a notification to a Slack channel you would like to get information on.
As a sample, [#github-actions-notifications - hayat01sh1da](https://hayat01sh1da.slack.com/archives/C09BBHZPD5E) is set as the target channel.
> 【github-wiki-organisers Weekly Unowned Wiki Count Report】
> [Unknown Owner nor Necessity: 1](https://github.com/hayat01sh1da/github-wiki-organisers/wiki#unowned-but-necessary-wiki)
> [Unowned but Necessary: 1](https://github.com/hayat01sh1da/github-wiki-organisers/wiki#unknown-owner-nor-necessity-wiki)
> [Unowned: 10](https://github.com/hayat01sh1da/github-wiki-organisers/wiki#unowned)
#### 4-2-3. Notify Uncategorised Wiki Count by Namespace
[Notify Uncategorised Wiki Count by Namespace](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/notify-uncategorised-wiki-count-by-namespace.yml) runs to notify unknown wikis in terms of category at 09:00 every Monday.
If there is any difference, it pushes a commit to the remote repository and send a notification to a Slack channel you would like to get information on.
As a sample, [#github-actions-notifications - hayat01sh1da](https://hayat01sh1da.slack.com/archives/C09BBHZPD5E) is set as the target channel.
> 【github-wiki-organisers Weekly Uncategorised Wiki Count by Namespace Report】
> [Uncategorised: 14](https://github.com/hayat01sh1da/github-wiki-organisers/wiki#uncategorised)
#### 4-2-4. Export Unknown Wiki List for LLM
[Export Unknown Wiki List for LLM](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/export-unknown-wiki-list-for-llm.yml) runs to notify export of ignored wiki page list for LLM in terms of noise canceling at 00:00 every weekday.
If there is any difference, it pushes a commit to the remote repository and send a notification to a Slack channel you would like to get information on.
As a sample, [#github-actions-notifications - hayat01sh1da](https://hayat01sh1da.slack.com/archives/C09BBHZPD5E) is set as the target channel.
Message: The latest ignored page list for LLM has been exported! Make sure if it is as you expect by cloning hayat01sh1da/github-wiki-organisers.wiki !
Workflows: [Export Unknown Wiki List for LLM](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/export-unknown-wiki-list-for-llm.yml)
> 【github-wiki-organisers Wiki LLM Notification for Ignored Page List Export】
> Message: The latest ignored page list for LLM has been exported! Make sure if it is as you expect by cloning hayat01sh1da/github-wiki-organisers.wiki !
> Workflows: [Export Unknown Wiki List for LLM](https://github.com/hayat01sh1da/github-wiki-organisers/actions/workflows/export-unknown-wiki-list-for-llm.yml)
