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

Refactor Structure #757

Closed
15 tasks
Starlight220 opened this issue Jul 6, 2020 · 11 comments
Closed
15 tasks

Refactor Structure #757

Starlight220 opened this issue Jul 6, 2020 · 11 comments
Labels
Needs Design Decision Waiting On: FIRST Waiting on something from FIRST

Comments

@Starlight220
Copy link
Member

Starlight220 commented Jul 6, 2020

Discussion of changes got a bit off-topic in #726 and went to general changes that are not directly connected to the "Getting Started" rewrite. So the discussion of article refactoring can be done here. I'll start a checklist of changes/refactorings that should be done, and any additions are welcome - add a comment and me or one of the maintainers (probably @Daltz333) will add it to the checklist.

Some topics that need articles written, and structure is relevant (note that some of these have their own GH issues):

As there are many issues with the "FRC Software Component Overview" article. Each tool should be split somewhere else. Some work is being done for this in #604. Here's a quick overview of my suggestions:

  • Radio Config Utility -> Networking section
  • roboRIO Imaging Tool -> "Imaging Your roboRIO"
  • LabVIEW, Simulator, maybe LV Dashboard too -> LabVIEW Components (new article, or work into the existing LV docs)
  • Axis Camera Setup -> Configuring an Axis Camera
  • DS, all of the dashboards -> perhaps a new "Operator Interface"/"Driver Station" article?
  • VSCode, RobotBuilder -> Software Components (C++/Java) with more emphasis on each, maybe merge with VSC basics
@Daltz333
Copy link
Member

Daltz333 commented Jul 6, 2020

Please note that any hardware changes requires FIRST approval beforehand.

@Daltz333 Daltz333 added Needs Design Decision Waiting On: FIRST Waiting on something from FIRST labels Jul 6, 2020
@Starlight220
Copy link
Member Author

WDYM "hardware changes"?

@Starlight220
Copy link
Member Author

I'm adding some stuff from other issues into the checklist, as they are relevant

@Daltz333
Copy link
Member

Daltz333 commented Jul 6, 2020

Any hardware article additions or major changes need FIRST approval.

@Starlight220
Copy link
Member Author

I'm starting to work on some of the smaller changes above, and submit a PR for each one. If there are some issues that are problematic/should be handled differently, please let me know before I spend too much time on them.

@Starlight220
Copy link
Member Author

What software components are relevant only to LV, or not relevant to LV at all?
I assume VSCode and RobotBuilder fall under the second category; while Robot Simulator, LV FRC, and maybe the LV dashboard fall under the first. Anything else?

@Daltz333
Copy link
Member

Basically.

@sciencewhiz
Copy link
Collaborator

LV Dashboard is interopable with C++/Java robot code and smartdashboard/shuffleboard work with LabVIEW robot. They are not the most common, but are supported (my team ran LabVIEW dashboard with Java robot for several years).

@Starlight220
Copy link
Member Author

So how do you propose we divide the components? Or perhaps all dashboards should be split into a separate article?

@Daltz333
Copy link
Member

I've been a big fan of per-topic structure for a long time.

@jasondaming
Copy link
Member

I think this issue should probably be closed in favor of a bunch of the other restructure issues that are more up to date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Design Decision Waiting On: FIRST Waiting on something from FIRST
Projects
None yet
Development

No branches or pull requests

4 participants