Feasibility: Assess viability of automatic updates to documentation

Aveline-art commented 3 years ago

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 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

JessicaLucindaCheng commented 1 year ago

This issue needs to be edited by a lead to reflect our migration to the website-wiki repo. For more info, read How to Contribute to the Wiki.

vincentdang commented 1 year ago

@JessicaLucindaCheng I'm curious to know more about this issue.

JessicaLucindaCheng commented 1 year ago

@vincentdang I don't actually know much about it. I left a comment because of the issue in the Dependency section. Sorry.

vincentdang commented 1 year ago

@JessicaLucindaCheng oh okay. I was debating on whether I should take it on.

JessicaLucindaCheng commented 1 year ago

@roslynwythe

I saw this issue was moved directly from the Ice Box to the Prioritized Backlog and I'm not sure if it was determined this issue didn't need edits. I left the following comment when I moved this issue to the Ice Box https://github.com/hackforla/website/issues/2228#issuecomment-1484398262:

This issue needs to be edited by a lead to reflect our migration to the website-wiki repo. For more info, read How to Contribute to the Wiki.
- Since this issue was written before the wiki migration to MkDocs, does this issue need to be edited to reflect the migration?
- Also, this issue may need clarification because a developer, Vincent, reached out to me asking me for more information about this issue (see comments in this issue) and I didn't have more info than what is written in the issue itself.
- In addition, is the website-wiki repo ready for developers to start contributing to it? If not, this may need to be put back in the "Ice Box" and the "Dependency" section needs to be edited for what needs to be done in order for this issue to come out of the "Ice Box".

github-actions[bot] commented 6 months ago

Hi @ramitaarora, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

ramitaarora commented 6 months ago

i. Availability: 9am-12pm Weekdays ii. ETA: April 30

ramitaarora commented 6 months ago

Currently blocked: I have forked the repo and made a new branch to make edits. I see the reflected changes in the branch when using docker and locally hosting it - am I supposed to see it change on the Wiki tab on the GitHub fork? Currently, the Wiki is empty.

https://github.com/ramitaarora/hfla-website-wiki/tree/feasibility-2228

Thanks so much!

@t-will-gillis I was suggested to ask you for help!

t-will-gillis commented 6 months ago

Hey @ramitaarora I am going to ask @JessicaLucindaCheng and @roslynwythe to weigh in on this. I am not sure how moving the Wiki to MkDocs affects this issue.

roslynwythe commented 6 months ago

@ramitaarora I don't believe it will be possible to work on this issue right now because the process and documentation for updating the new wiki are not in place, and I am not certain how long that will take, so I need to unassign you and apply a dependency to the issue. I apologize for not catching the error sooner.

ramitaarora commented 6 months ago

@roslynwythe Thanks Roslyn! No problem at all.

hackforla / website