hackforla / hackforla/website

Feasibility: Assess viability of automatic updates to documentation

Open
#2,228 11 comments 0 reactions 0 assignees View on GitHub
Complexity: Large Dependency Feature: Wiki role: back end/devOps size: 3pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Dependency
- #3636
- #2676

### 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:
- [x] Perform edits to files within a repository (please test this on your own repo)
- [x] 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](https://www.vrms.io/api/recurringevents) 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:

1. download the wiki (the wiki is [a repo](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis))!
2. read a file in the wiki
3. make changes!
4. push the repo back

When making a demo, you can also look at the [gollum trigger for GHAs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#gollum) and attempt to ~~steal the one ring that rules them all~~ create a demo using a GHA.

[About wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis)
[Events that trigger workflows](https://docs.github.com/en/actions/reference/events-that-trigger-workflows)
[Wiki home](https://github.com/hackforla/website/wiki)
[website/CONTRIBUTING.md ](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.