Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: share wiki contents in the repository #12300

Open
vitorhcl opened this issue Feb 19, 2024 · 1 comment
Open

Proposal: share wiki contents in the repository #12300

vitorhcl opened this issue Feb 19, 2024 · 1 comment

Comments

@vitorhcl
Copy link
Member

The GitHub wiki is not ideal for contributions because it only allows direct commits. However, we can include a workflow that takes the the pages from some directory (e.g. docs/ or wiki/) and pushes them into the GitHub wiki. Here's an example of workflow that does that: https://nimblehq.co/blog/create-github-wiki-pull-request.

That would allow opening PRs for modifying wiki pages, which would vastly improve the contributions quality and thus the wiki quality.

@kbdharun
Copy link
Member

kbdharun commented Feb 19, 2024

Thanks for proposing this approach again, we have been discussing it for a while in the chatroom and here #10133, but we didn't implement it as we didn't find an actively maintained action. I think this approach with using Git directly would work the best so +1 from me.

Currently, we monitor edits using the Atoms feed using Feed Bot in Element which sends a message in the chatroom. But since Atom feeds for the Wiki is no longer actively promoted IDK how long this approach would be viable as GitHub might remove it any time, so restricting wiki to collaborators and suggesting them to send a PR would work the best. (But in that case, we need to add a disclaimer to not edit it over there for collaborators).

Also, we need to consider whose personal access token we are going to use. I would highly discourage using classic PATs from individual users (and we could go with a fine-grained one); organization PAT rules are currently in beta we could enrol for it if we need to do this.

Edit. This would also fix issues with incorrect filename/title breaking the whole page i.e. @vitorhcl's commit yesterday broke the client's page as it had an incorrect file name (I fixed it right now).

Reference for Org PAT rules

image

Link: https://github.com/organizations/tldr-pages/settings/personal-access-tokens-onboarding

Took this screenshot from another Org, but post enrollment it will look roughly like this:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants