Feasibility: Assess viability of automatic updates to documentation #2228
Description
Dependency
Overview
As a developer, we need documentation that is up-to-date and easy to maintain that way. In this issue, we will be performing a feature assessment on having automatic updates on the wiki and our contributing documentation.
Action Items
- Assess whether a program can:
- Perform edits to files within a repository (please test this on your own repo)
- Perform edits to a wiki (please test this in your own wiki)
- If either is possible, list out the permissions that would be required by any API tokens, and any technology that we need
- Create a demo that can parse and read meetings times from our vrms api and display it in a table on the wiki.
Resources/Instructions
Currently, most of our documentation is outdated, or defunct, and this presents a really big problem for new members of the team. While most documentation must be manually reviewed, if it can be automatically updated, even if partially, it would be a big help to the team. For example, we would love to have a program update a wiki about labels or milestones as we add, remove, or edit them!
The mechanism through which automatic updates can be done probably involves these steps:
- download the wiki (the wiki is a repo)!
- read a file in the wiki
- make changes!
- push the repo back
When making a demo, you can also look at the gollum trigger for GHAs and attempt to steal the one ring that rules them all create a demo using a GHA.
About wikis
Events that trigger workflows
Wiki home
website/CONTRIBUTING.md