Major docs updates

[MatthewL246]

Currently, the docs are a mix of being tracked in this repository as source files under the HelpPage directory (and built during the Pages deploy), being cloned into that directory during the Pages deploy, and just static files. I think that we should make these more consistent by moving everything that needs to be built into separate repositories and linking to them from the docs. Then, we can delete the history of HelpPage in XaverianTeamRobotics/FtcRobotController#524 to remove all of the unnecessary build files that were added there and are increasing our repo size.

Tasks:

• Complete this task list.
• Move the docs to its own repo: https://github.com/XaverianTeamRobotics/docs
  • Set up build and deployment actions
  • Configure Pages for https://robotics.xbhs.net
  • Set up required code reviews and CODEOWNERS here
  • Set up Dependabot updates
• Move imgutil to its own repo: https://github.com/XaverianTeamRobotics/imgutil
  • Set up build and deployment actions
  • Configure Pages
  • Set up Dependabot updates
• Set up Pages and deployments for the webinstaller repo: https://github.com/XaverianTeamRobotics/webinstaller
• Decide what to do with legacy-apk (might just delete it)
• Simplify the Pages action in FtcRobotController to only build the APK and Javadocs
• Update the links in these docs to refer to the new repositories
• Document the new repositories and how to edit them (A guide to the GitHub features we use #24)
• Nuke HelpPage to reduce repo size in (XaverianTeamRobotics/FtcRobotController#524)

[MatthewL246]

@michaell4438 Do you think it would be okay to publish the docs at https://robotics.xbhs.net and set up our various other websites (Javadocs, webinstaller, imgutil) to be hosted on github.io pages? I was thinking that a new repo for the docs would make sense, and we could set the robotics.xbhs.net DNS to point to that instead.

I believe that this would make all of the websites easier to maintain because it eliminates the deployments depending on changes from multiple repositories. Now, if we wanted everything to be hosted on https://robotics.xbhs.net at the same time, the right way to do that would be using a reverse proxy like nginx to point robotics.xbhs.net/apk to xaverianteamrobotics.github.io/webinstaller. However, that would require an actual server (as I do not think that Cloudflare has a free reverse proxy option), which we do not have.

[MatthewL246]

I set up https://github.com/XaverianTeamRobotics/docs and imported the history from the docs here (thanks git-filter-repo).

[michaell4438]

@michaell4438 Do you think it would be okay to publish the docs at https://robotics.xbhs.net and set up our various other websites (Javadocs, webinstaller, imgutil) to be hosted on github.io pages? I was thinking that a new repo for the docs would make sense, and we could set the robotics.xbhs.net DNS to point to that instead.

I believe that this would make all of the websites easier to maintain because it eliminates the deployments depending on changes from multiple repositories. Now, if we wanted everything to be hosted on https://robotics.xbhs.net at the same time, the right way to do that would be using a reverse proxy like nginx to point robotics.xbhs.net/apk to xaverianteamrobotics.github.io/webinstaller. However, that would require an actual server (as I do not think that Cloudflare has a free reverse proxy option), which we do not have.

yeah seems like it could work

[MatthewL246]

Looks like the documentation migration was a success!