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

Add the Wiki to version control with GH action to publish to Wiki? #279

Closed
yorkshire-pudding opened this issue Apr 12, 2023 · 0 comments · Fixed by #416 or #417
Closed

Add the Wiki to version control with GH action to publish to Wiki? #279

yorkshire-pudding opened this issue Apr 12, 2023 · 0 comments · Fixed by #416 or #417

Comments

@yorkshire-pudding
Copy link
Collaborator

yorkshire-pudding commented Apr 12, 2023

Currently updating the wiki is a separate action to making a change to commands and relies on someone remembering to do it. My proposal is to add the wiki to the repo with a GitHub action to publish to the wiki area when merged.

Pros

  • Allows wiki changes to be drafted as part of a pull request
  • Wiki can be drafted using an IDE which will be more user friendly than the edit window for long pages.
  • Less likely to forget to do wiki changes after the merge if need to be done at the same time
  • Ties documentation changes to changes in commands, behaviour, or the API so the docs in a given version installed would match the functionality in that version.
  • Would make it easier to add screenshots to the wiki as could have subfolder for images
  • Some anecdotal evidence that locked down wikis can be indexed by Google, although we need a few more stars

Cons

  • Would need to lock down the wiki as any changes made on the wiki screen would be lost on the next merge. There have been no wiki edits by people who wouldn't know how to do a PR so I'm not sure this would be a problem.
  • Different workflow may take a bit of getting used to (I don't think any other backdrop projects do this)

The GH action I've found which seems to work well is: https://github.com/Andrew-Chen-Wang/github-wiki-action.

Thoughts?

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